Skip to content

docs: update project documentation and previews - #17

Merged
CodingWithJiro merged 13 commits into
mainfrom
docs/update-project-documentation
Sep 4, 2026
Merged

CodingWithJiro merged 13 commits into
mainfrom
docs/update-project-documentation

Conversation

@CodingWithJiro

Copy link
Copy Markdown
Owner

Description

Updated the project documentation and preview assets before starting the next feature.

Changes

  • Updated README.md feature descriptions for the blog and projects pages.
  • Added Content Architecture to the Engineering Highlights.
  • Added Structured Metadata and MDX Content to Engineering Decisions.
  • Updated the Future Improvements section for the upcoming Tech Stack expansion.
  • Added MDX and Tailwind CSS Typography to the Tech Stack.
  • Updated the Project Structure with new directories and configuration files.
  • Updated the test coverage badge to 85%.
  • Updated the README.md author section with the latest update date.
  • Refreshed the Lighthouse report assets.
  • Replaced the outdated site preview with updated MacBook Air and iPhone 14 mockups.

Notes for Reviewers

  • I just updated the documentations to reflect the latest of image of my site.
  • I did remove the site preview one since the image is stretched and just used better mockups.
  • Will be planning on updating this again once more features merged.

@CodingWithJiro CodingWithJiro self-assigned this Sep 4, 2026
@CodingWithJiro CodingWithJiro added documentation Improvements or additions to documentation chore labels Sep 4, 2026
@vercel

vercel Bot commented Sep 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
elmarchavez Ready Ready Preview Sep 4, 2026 6:12pm UTC

@CodingWithJiro

Copy link
Copy Markdown
Owner Author

In a team setting, this PR would await senior developer approval.
For this solo project, I’ll proceed with merging after review.

@CodingWithJiro
CodingWithJiro merged commit 260c249 into main Sep 4, 2026
6 checks passed
@CodingWithJiro
CodingWithJiro deleted the docs/update-project-documentation branch September 4, 2026 18:18

This branch was successfully deployed

1 active deployment
Preview — a64c710b Deployed Sep 4, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant