Skip to content

Commit 6875f20

Browse files
committed
Refactor documentation structure: update blog post guide references, renumber sections, and remove outdated files
Signed-off-by: Daniel Ntege <danientege785@gmail.com>
1 parent c625623 commit 6875f20

8 files changed

Lines changed: 30 additions & 30 deletions

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@ Netlify builds run `pnpm install` and `pnpm run build` (see `netlify.toml`).
9292
## Documentation
9393

9494
- **[Docs Hub](docs/README.md)** - First stop for contributors (repository architecture, content workflows, quality checks)
95-
- **[Adding Blog Posts](docs/07-adding-blog-post.md)** - Post-specific workflow for `content/posts/`, front matter, and `/posts/...` linking conventions
95+
- **[Adding Blog Posts](docs/04-adding-blog-post.md)** - Post-specific workflow for `content/posts/`, front matter, and `/posts/...` linking conventions
9696
- **[Adding New Pages Guide](ADDING_PAGES.md)** - Legacy page-creation guide with EN/DE examples and image/layout notes
9797

docs/02-content-folder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ content/posts/
7272

7373
**Usage**: Blog articles, release notes, announcements
7474

75-
For a complete, post-specific workflow (including front matter and link conventions), see [07 - Adding Blog Posts](./07-adding-blog-post.md).
75+
For a complete, post-specific workflow (including front matter and link conventions), see [04 - Adding Blog Posts](./04-adding-blog-post.md).
7676

7777
### Pattern 3: Version Updates CHANGELOG
7878

docs/03-adding-pages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ This comprehensive guide walks you through the entire process of adding a new pa
99
Before starting, ensure you're familiar with:
1010
- [01 - Repository Overview](./01-repo-overview.md): Project structure and technology stack
1111
- [02 - Content Folder Guide](./02-content-folder.md): Content organization, front matter standards, and localization
12-
- [07 - Adding Blog Posts](./07-adding-blog-post.md): Use this instead when your change is in `content/posts/`
12+
- [04 - Adding Blog Posts](./04-adding-blog-post.md): Use this instead when your change is in `content/posts/`
1313
- Basic Next.js App Router concepts (routes, layouts, page components)
1414

1515
This guide is for standard pages (`content/<slug>/index.md` + route files).
16-
For posts in `content/posts/`, follow [07 - Adding Blog Posts](./07-adding-blog-post.md).
16+
For posts in `content/posts/`, follow [04 - Adding Blog Posts](./04-adding-blog-post.md).
1717

1818
## Step-by-Step Implementation Workflow
1919

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 07 - Adding Blog Posts
1+
# 04 - Adding Blog Posts
22

33
## Purpose
44

@@ -112,5 +112,5 @@ Reference them with web paths:
112112
## Related Docs
113113

114114
- [02 - Content Folder Guide](./02-content-folder.md)
115-
- [04 - First Contribution Checklist](./04-first-contribution-checklist.md)
116-
- [05 - Testing and Quality Checks](./05-testing-and-quality-checks.md)
115+
- [05 - First Contribution Checklist](./05-first-contribution-checklist.md)
116+
- [06 - Testing and Quality Checks](./06-testing-and-quality-checks.md)

docs/05-first-contribution-checklist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 04 - First Contribution Checklist
1+
# 05 - First Contribution Checklist
22

33
## Purpose and Scope
44

@@ -438,4 +438,4 @@ git push origin fix/issue-123-description
438438
- **Stuck on implementation?** → Check [01 - Repository Overview](./01-repo-overview.md)
439439
- **Content structure unclear?** → See [02 - Content Folder Guide](./02-content-folder.md)
440440
- **Adding a new page?** → Follow [03 - Adding Pages](./03-adding-pages.md)
441-
- **Build or test failures?** → Check [05 - Testing and Quality Checks](./05-testing-and-quality-checks.md)
441+
- **Build or test failures?** → Check [06 - Testing and Quality Checks](./06-testing-and-quality-checks.md)

docs/06-testing-and-quality-checks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 05 - Testing and Quality Checks
1+
# 06 - Testing and Quality Checks
22

33
## Overview
44

docs/07-github-automation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 06 - GitHub Automation Guide
1+
# 07 - GitHub Automation Guide
22

33
## Purpose and Scope
44

@@ -159,7 +159,7 @@ Welcome to your first contribution! Here's what you need to know:
159159
1. Start with: docs/README.md → "Getting Started"
160160
2. Next, read: docs/01-repo-overview.md
161161
3. For implementation help: see docs/03-adding-pages.md
162-
4. Before submitting PR: review docs/04-first-contribution-checklist.md
162+
4. Before submitting PR: review docs/05-first-contribution-checklist.md
163163
164164
Questions? Ask here in the issue - maintainers are happy to help!
165165
```
@@ -410,7 +410,7 @@ If you need to modify workflow behavior:
410410
- Ensure JSON is valid
411411

412412
3. **Update this documentation**:
413-
- In the same PR, update this file (06-github-automation.md)
413+
- In the same PR, update this file (07-github-automation.md)
414414
- Explain what changed and why
415415
- Give examples if behavior is user-visible
416416

docs/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ The following guides provide structured information organized by topic and use c
2121
| [01 - Repository Overview](./01-repo-overview.md) | Comprehensive overview of project structure, technology stack, and architectural patterns | All contributors |
2222
| [02 - Content Folder Guide](./02-content-folder.md) | Detailed explanation of content organization, markdown structure, and content management model | Content contributors, page editors |
2323
| [03 - Adding Pages](./03-adding-pages.md) | Step-by-step guide to implementing new pages including routing, content, and component integration | Feature developers, content editors |
24-
| [04 - First Contribution Checklist](./04-first-contribution-checklist.md) | Pre-submission validation checklist ensuring code quality, documentation completeness, and testing coverage | All contributors |
25-
| [05 - Testing and Quality Checks](./05-testing-and-quality-checks.md) | Comprehensive guide to automated testing, linting, build validation, and quality assurance procedures | Developers, QA reviewers |
26-
| [06 - GitHub Automation Guide](./06-github-automation.md) | Documentation of automated workflows, CI/CD processes, and GitHub Actions behavior | Maintainers, advanced contributors |
27-
| [07 - Adding Blog Posts](./07-adding-blog-post.md) | Dedicated workflow for post creation in `content/posts/`, including front matter, URL rules, and linking conventions | Content contributors, editors |
24+
| [04 - Adding Blog Posts](./04-adding-blog-post.md) | Dedicated workflow for post creation in `content/posts/`, including front matter, URL rules, and linking conventions | Content contributors, editors |
25+
| [05 - First Contribution Checklist](./05-first-contribution-checklist.md) | Pre-submission validation checklist ensuring code quality, documentation completeness, and testing coverage | All contributors |
26+
| [06 - Testing and Quality Checks](./06-testing-and-quality-checks.md) | Comprehensive guide to automated testing, linting, build validation, and quality assurance procedures | Developers, QA reviewers |
27+
| [07 - GitHub Automation Guide](./07-github-automation.md) | Documentation of automated workflows, CI/CD processes, and GitHub Actions behavior | Maintainers, advanced contributors |
2828

2929
## Getting Started: Recommended Reading Path
3030

@@ -47,12 +47,12 @@ To successfully onboard and make your first contribution, please follow this rea
4747
- Learn the integration pattern between content and routing
4848
- Understand asset management
4949

50-
4. **[07 - Adding Blog Posts](./07-adding-blog-post.md)** (5 min, when working on posts)
50+
4. **[04 - Adding Blog Posts](./04-adding-blog-post.md)** (5 min, when working on posts)
5151
- Learn the post-specific filename and front matter schema
5252
- Follow `/posts/...` routing conventions and linking rules
5353
- Avoid common metadata and visibility mistakes
5454

55-
5. **[04 - First Contribution Checklist](./04-first-contribution-checklist.md)** (5 min)
55+
5. **[05 - First Contribution Checklist](./05-first-contribution-checklist.md)** (5 min)
5656
- Validate your work before submitting a pull request
5757
- Ensure all quality gates are met
5858
- Review PR submission requirements
@@ -61,9 +61,9 @@ To successfully onboard and make your first contribution, please follow this rea
6161

6262
Consult these documents as needed while actively developing:
6363

64-
- **[05 - Testing and Quality Checks](./05-testing-and-quality-checks.md)** - When running validation commands or debugging test failures
65-
- **[06 - GitHub Automation Guide](./06-github-automation.md)** - When troubleshooting CI failures or understanding review workflows
66-
- **[07 - Adding Blog Posts](./07-adding-blog-post.md)** - When adding or translating any file in `content/posts/`
64+
- **[06 - Testing and Quality Checks](./06-testing-and-quality-checks.md)** - When running validation commands or debugging test failures
65+
- **[07 - GitHub Automation Guide](./07-github-automation.md)** - When troubleshooting CI failures or understanding review workflows
66+
- **[04 - Adding Blog Posts](./04-adding-blog-post.md)** - When adding or translating any file in `content/posts/`
6767

6868
## Local Development Environment
6969

@@ -172,7 +172,7 @@ All documentation updates must:
172172
### Example Scenarios
173173

174174
- **Adding a new configuration option?** → Update the relevant guide and include it in your PR alongside the code change
175-
- **Changing CI workflow?** → Update `06-github-automation.md` in the same PR
175+
- **Changing CI workflow?** → Update `07-github-automation.md` in the same PR
176176
- **Restructuring content organization?** → Update `02-content-folder.md` along with your code changes
177177

178178
## Common Workflow Patterns
@@ -181,30 +181,30 @@ All documentation updates must:
181181

182182
1. Read [01 - Repository Overview](./01-repo-overview.md) to locate the relevant code
183183
2. Make your code changes and ensure they pass: `pnpm run lint && pnpm run build && pnpm run test:e2e`
184-
3. Use [04 - First Contribution Checklist](./04-first-contribution-checklist.md) before submitting the PR
184+
3. Use [05 - First Contribution Checklist](./05-first-contribution-checklist.md) before submitting the PR
185185

186186
### Adding or Updating Content
187187

188188
1. Follow [02 - Content Folder Guide](./02-content-folder.md) for content structure
189189
2. Study [03 - Adding Pages](./03-adding-pages.md) if adding new pages
190-
3. Use [07 - Adding Blog Posts](./07-adding-blog-post.md) for any blog/article work in `content/posts/`
190+
3. Use [04 - Adding Blog Posts](./04-adding-blog-post.md) for any blog/article work in `content/posts/`
191191
4. Verify quality with the validation commands
192-
5. Reference [04 - First Contribution Checklist](./04-first-contribution-checklist.md) when ready to submit
192+
5. Reference [05 - First Contribution Checklist](./05-first-contribution-checklist.md) when ready to submit
193193

194194
### Implementing a Feature
195195

196196
1. Start with [01 - Repository Overview](./01-repo-overview.md)
197197
2. Understand existing patterns in the codebase before implementing
198198
3. For frontend changes, refer to component patterns and TypeScript conventions
199199
4. Run full validation suite: `pnpm run lint && pnpm run build && pnpm run test:e2e`
200-
5. Follow the checklist in [04 - First Contribution Checklist](./04-first-contribution-checklist.md)
200+
5. Follow the checklist in [05 - First Contribution Checklist](./05-first-contribution-checklist.md)
201201

202202
## Support and Troubleshooting
203203

204-
- **Build or test failures?** → Consult [05 - Testing and Quality Checks](./05-testing-and-quality-checks.md)
205-
- **Unsure about automation behavior?** → Review [06 - GitHub Automation Guide](./06-github-automation.md)
204+
- **Build or test failures?** → Consult [06 - Testing and Quality Checks](./06-testing-and-quality-checks.md)
205+
- **Unsure about automation behavior?** → Review [07 - GitHub Automation Guide](./07-github-automation.md)
206206
- **Need help with page structure?** → Check [03 - Adding Pages](./03-adding-pages.md) or [02 - Content Folder Guide](./02-content-folder.md)
207-
- **Need help with post metadata or `/posts/...` links?** → Check [07 - Adding Blog Posts](./07-adding-blog-post.md)
207+
- **Need help with post metadata or `/posts/...` links?** → Check [04 - Adding Blog Posts](./04-adding-blog-post.md)
208208
- **Repository questions?** → See [01 - Repository Overview](./01-repo-overview.md) for architecture and structure details
209209

210210
## Additional Resources

0 commit comments

Comments
 (0)