You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,6 +92,6 @@ Netlify builds run `pnpm install` and `pnpm run build` (see `netlify.toml`).
92
92
## Documentation
93
93
94
94
-**[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
96
96
-**[Adding New Pages Guide](ADDING_PAGES.md)** - Legacy page-creation guide with EN/DE examples and image/layout notes
Copy file name to clipboardExpand all lines: docs/README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,10 +21,10 @@ The following guides provide structured information organized by topic and use c
21
21
|[01 - Repository Overview](./01-repo-overview.md)| Comprehensive overview of project structure, technology stack, and architectural patterns | All contributors |
22
22
|[02 - Content Folder Guide](./02-content-folder.md)| Detailed explanation of content organization, markdown structure, and content management model | Content contributors, page editors |
23
23
|[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|
28
28
29
29
## Getting Started: Recommended Reading Path
30
30
@@ -47,12 +47,12 @@ To successfully onboard and make your first contribution, please follow this rea
47
47
- Learn the integration pattern between content and routing
48
48
- Understand asset management
49
49
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)
51
51
- Learn the post-specific filename and front matter schema
52
52
- Follow `/posts/...` routing conventions and linking rules
53
53
- Avoid common metadata and visibility mistakes
54
54
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)
56
56
- Validate your work before submitting a pull request
57
57
- Ensure all quality gates are met
58
58
- Review PR submission requirements
@@ -61,9 +61,9 @@ To successfully onboard and make your first contribution, please follow this rea
61
61
62
62
Consult these documents as needed while actively developing:
63
63
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/`
67
67
68
68
## Local Development Environment
69
69
@@ -172,7 +172,7 @@ All documentation updates must:
172
172
### Example Scenarios
173
173
174
174
-**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
176
176
-**Restructuring content organization?** → Update `02-content-folder.md` along with your code changes
177
177
178
178
## Common Workflow Patterns
@@ -181,30 +181,30 @@ All documentation updates must:
181
181
182
182
1. Read [01 - Repository Overview](./01-repo-overview.md) to locate the relevant code
183
183
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
185
185
186
186
### Adding or Updating Content
187
187
188
188
1. Follow [02 - Content Folder Guide](./02-content-folder.md) for content structure
189
189
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/`
191
191
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
193
193
194
194
### Implementing a Feature
195
195
196
196
1. Start with [01 - Repository Overview](./01-repo-overview.md)
197
197
2. Understand existing patterns in the codebase before implementing
198
198
3. For frontend changes, refer to component patterns and TypeScript conventions
199
199
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)
201
201
202
202
## Support and Troubleshooting
203
203
204
-
-**Build or test failures?** → Consult [05 - Testing and Quality Checks](./05-testing-and-quality-checks.md)
0 commit comments