Skip to content

Commit c1f0095

Browse files
committed
updated future roadwork section in readme file
1 parent 9cdda37 commit c1f0095

10 files changed

Lines changed: 21 additions & 6 deletions

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,12 @@ This project is a continuous work in progress. Here are some of the features and
9696
9797
* `[ ]` **Integrate a CSS Framework (e.g., Bootstrap):** To further improve the responsive design and accelerate the addition of new UI components, I plan to refactor the custom CSS to use a professional framework. This will involve updating the HTML templates to use the framework's class system.
9898

99-
* `[ ]` **Implement a Direct Contact Form:** To provide an alternative to the `mailto:` link, I plan to integrate a third-party service (like Formspree) to handle direct message submissions from a form on the contact page. This will require setting up the service and adding a `<form>` element to the `contact_template.html`.
99+
* `[ ]` **Implement a Direct Contact Form:** To provide an alternative to the `mailto:` link, I plan to integrate a third-party service (like Formspree) to handle direct message submissions from a form on the contact page. This will require setting up the service and adding a `<form>` element to the [`contact_template.html`](contact_template.html).
100100

101101
* `[x]` **Add Search Functionality:** Implemented a client-side search feature using vanilla JavaScript. A search index is auto-generated at build time and a floating search button (with ⌘K shortcut) opens a modal overlay to search across all blog post titles, summaries, and tags.
102102

103103
* `[ ]` **Content Expansion:**
104-
* Add more projects to the `json` file.
104+
* Add more projects to the [`json`](portfolio-mit_v1.json) file.
105105
* Write more technical blog posts.
106106
* Continue to expand and refine the `tech_stack` with new skills.
107107

@@ -115,24 +115,39 @@ This project is a continuous work in progress. Here are some of the features and
115115

116116
* `[ ]` **Organise data inside `json` file:**
117117
* Keep the data in a structured format so there are no duplicates.
118-
* The data for a project/blog must be together (`project_db`) to make it easier to edit details like Github URLs, blog images, project card thumbnail, blog home page summary, etc, etc, etc.
119-
* Follow the structure given in `update-data.json` and `project_db.json` in `future-work/` folder.
118+
* The data for a project/blog must be together ([`project_db`](future-work/project_db.json)) to make it easier to edit details like Github URLs, blog images, project card thumbnail, blog home page summary, etc, etc, etc.
119+
* Follow the structure given in [`update-data.json`](future-work/updated-data.json) and [`project_db.json`](future-work/project_db.json) in [`future-work`](future-work/) folder.
120120

121121
* `[ ]` **Add read story section in project page:**
122122
* In the project page, under the given project card, add a link to read the blog along with viewing it on github.
123123
* The blog will be redirected to the 1st blog in the series.
124124

125125
* `[ ]` **Keep 3 projects columns:**
126-
* Need to make changes in `project_template` to make sure it includes 3 project cards in each row. (see `future-work/images/project-page.png`)
126+
* Need to make changes in [`project_template`](projects_template.html) to make sure it includes 3 project cards in each row. (see [`future-work/images/project-page.png`](future-work/images/project-page.png))
127127

128128
* `[ ]` **Add heading sections inside blog post page:**
129129
* In the blog post page, add page headings and links for easy scrolling and navigating through the page.
130130
* This also helps in giving a brief of the blog post page.
131-
* See `future-work/images/blog-post-page.png` for reference and `future-work/images/reference-sample.png`
131+
* See [`future-work/images/blog-post-page.png`](future-work/images/blog-post-page.png) for reference and [`future-work/images/reference-sample.png`](future-work/images/reference-sample.png)
132132

133133
* `[ ]` **Architecture diagram and video or a gif:**
134134
* Add architecture diagram of the project or the blog or create a video doing a walkthrough of the project or a gif of the working ui.
135135

136136
* `[x]` **Add horizontal progress scroll bar:**
137137
* Add horizontal progress scroll bar to the top of the page to make it easier for users to navigate the page.
138138

139+
* `[ ]` **Add dynamic pagination for blog page:**
140+
* Add dynamic pagination for blog page to make it easier for users to navigate through the blog posts. --> `Load More Posts` button at the end of the blog page. (see [`future-work/images/dynamic-pagination.png`](future-work/images/dynamic-pagination.png))
141+
142+
* `[ ]` **Add table of contents in posts page:**
143+
* Add table of contents in posts page to make it easier for users to navigate through the blog posts. (see [`future-work/images/table-of-content-2.png`](future-work/images/table-of-content-2.png) and [`future-work/images/table-of-content-3.png`](future-work/images/table-of-content-3.png))
144+
145+
* `[ ]` **Add a section in blog page to show the number of posts:**
146+
* Add a section in blog page to show the number of posts. (see `future-work/images/number-of-posts.png`)
147+
148+
* `[ ]` **Clean individual html files by removing extra white space:**
149+
* Remove extra white space from individual html files to make them more readable. (see [`future-work/images/unclean-html-code-block.png`](future-work/images/unclean-html-code-block.png))
150+
151+
* `[ ]` **Modify the code such that the sidebar is fixed in the page while scrolling down (sticky positioning):**
152+
* where the sidebar (or an element) remains fixed in place while the rest of the page scrolls—is called "sticky positioning" in web design. (see [`future-work/images/sticky-positioning-highlight-01.png`](future-work/images/sticky-positioning-highlight-01.png) and [`future-work/images/sticky-positioning-highlight-02.png`](future-work/images/sticky-positioning-highlight-02.png))
153+
289 KB
Loading

future-work/images/sidebar-01.png

304 KB
Loading
304 KB
Loading
333 KB
Loading
289 KB
Loading
257 KB
Loading
17.5 KB
Loading
318 KB
Loading
169 KB
Loading

0 commit comments

Comments
 (0)