Skip to content

Commit

Permalink
docs: move maintenance doc to root
Browse files Browse the repository at this point in the history
- Move MAINTENANCE.md to root directory
- Update progress on all tracked issues
- Add documentation section to README
- Add contributing guidelines
  • Loading branch information
michaellambgelo committed Jan 9, 2025
1 parent a86bca8 commit 34ddf9b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/MAINTENANCE.md → MAINTENANCE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Site Maintenance Documentation

Last Updated: 2025-01-08
Last Updated: 2025-01-09

This document tracks known issues, recommendations, and maintenance tasks for the website.

Expand Down Expand Up @@ -118,6 +118,18 @@ This document tracks known issues, recommendations, and maintenance tasks for th
- Added markdown linting
- Added front matter validation

### 2025-01-09
1. Improved template organization:
- Moved post template to dedicated `_templates` directory
- Updated config to exclude templates from build
- Added comprehensive template guidelines
- Fixed template visibility in navigation

2. Enhanced documentation:
- Moved `MAINTENANCE.md` to root directory for better visibility
- Updated progress on all tracked issues
- Added links to documentation in README

_This section will be updated as changes are implemented._

---
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ I want my blog to be accessible, but still have some of my fingerprints on it.

If anything in my blog inspires you, I'd love to know about it.

## Documentation

- [Maintenance Guide](MAINTENANCE.md) - Track site issues, improvements, and progress
- [Post Template](_templates/post.md) - Template for creating new blog posts

## Contributing

Contributions are welcome! Please read the maintenance guide for current issues and improvements being tracked.

## Resources ##

[run this project locally](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll)
Expand Down

0 comments on commit 34ddf9b

Please sign in to comment.