Enhance documentation for blog post creation and content structure#293
Merged
danielmarv merged 3 commits intonext-js-migrationfrom Feb 27, 2026
Merged
Enhance documentation for blog post creation and content structure#293danielmarv merged 3 commits intonext-js-migrationfrom
danielmarv merged 3 commits intonext-js-migrationfrom
Conversation
Signed-off-by: Daniel Ntege <danientege785@gmail.com>
…and quality checks, and GitHub automation workflows - Created 05-first-contribution-checklist.md to guide new contributors through the contribution process. - Added 06-testing-and-quality-checks.md detailing mandatory quality checks and manual verification steps. - Introduced 07-github-automation.md outlining GitHub Actions automation for issue and PR management. Signed-off-by: Daniel Ntege <danientege785@gmail.com>
…renumber sections, and remove outdated files Signed-off-by: Daniel Ntege <danientege785@gmail.com>
7e6f0d9 to
6875f20
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request significantly improves and clarifies the documentation around adding blog posts and using front matter in the content system. It introduces a dedicated guide for blog post creation, updates front matter standards to distinguish between standard pages and posts, and ensures that routing, localization, and metadata conventions are clear for contributors. The changes also update checklists and cross-references throughout the documentation to reflect these new standards.
Major documentation improvements:
docs/07-adding-blog-post.md, detailing the workflow for adding blog posts, required front matter fields, file naming, routing, image handling, and common pitfalls.README.md) and reading path to reference the new blog post guide, and clarified when to use it versus the standard pages guide [1] [2] [3] [4] [5] [6].Front matter and content standards:
docs/02-content-folder.mdto clearly separate required front matter fields for standard pages vs. blog posts, provide field-specific notes, and supply updated YAML examples for each [1] [2].excerpt,categories,preview_image,showInBlog, andoutdated[1] [2].Localization and routing conventions:
/posts/...pattern (not/blog/...), and how filenames map to URLs in both English and German [1] [2] [3] [4].Workflow and checklist updates:
docs/03-adding-pages.mdand other locations.These changes make it much easier for contributors to add new blog posts correctly, follow best practices for metadata and localization, and avoid common mistakes.