Skip to content

Enhance documentation for blog post creation and content structure#293

Merged
danielmarv merged 3 commits intonext-js-migrationfrom
origin/actions-auto
Feb 27, 2026
Merged

Enhance documentation for blog post creation and content structure#293
danielmarv merged 3 commits intonext-js-migrationfrom
origin/actions-auto

Conversation

@danielmarv
Copy link
Member

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:

  • Added a new guide, 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.
  • Updated the main documentation hub (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:

  • Revised docs/02-content-folder.md to 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].
  • Added explicit instructions for blog post front matter, including new fields like excerpt, categories, preview_image, showInBlog, and outdated [1] [2].

Localization and routing conventions:

  • Clarified URL and routing rules for both standard pages and blog posts, emphasizing the /posts/... pattern (not /blog/...), and how filenames map to URLs in both English and German [1] [2] [3] [4].
  • Updated localization parity requirements and checklists to ensure blog posts and standard pages are handled appropriately for both languages [1] [2].

Workflow and checklist updates:

  • Updated pre-submission checklists and best practices to reflect new blog post requirements and validation steps, including front matter fields and localization expectations.
  • Clarified the distinction between guides for adding standard pages and blog posts in docs/03-adding-pages.md and 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.

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>
@danielmarv danielmarv merged commit 7ec5754 into next-js-migration Feb 27, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant