Conversation
…y overview, content guidelines, and contribution checklist Signed-off-by: Daniel Ntege <[email protected]>
…onfiguration Signed-off-by: Daniel Ntege <[email protected]>
3d44ce4 to
dd65941
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a new contributor documentation hub under docs/ and updates existing top-level contributor docs to point to it, while also cleaning up legacy configuration (config.toml) to reflect the current Next.js-based setup.
Changes:
- Added a structured contributor docs hub (
docs/README.md) plus six step-by-step guides covering repo structure, content workflow, testing, and GitHub automation. - Updated contributor entry points (
README.md,ADDING_PAGES.md) to direct newcomers to the new docs hub and clarifycontent/usage. - Removed the obsolete Hugo
config.toml.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
docs/README.md |
New documentation hub entry point with reading order and common commands. |
docs/01-repo-overview.md |
New repo overview doc describing architecture and key folders. |
docs/02-content-folder.md |
New guide describing content/ structure conventions and localization rules. |
docs/03-adding-pages.md |
New end-to-end quick process for adding a page (content, routes, assets, checks). |
docs/04-first-contribution-checklist.md |
New checklist for first-time contributors (branching, validation, PR expectations). |
docs/05-testing-and-quality-checks.md |
New contributor-facing testing/linting guidance and manual verification checklist. |
docs/06-github-automation.md |
New overview of issue/PR automation commands, reviewers config, and lifecycle. |
README.md |
Removes legacy Hugo block in “Runtime layers”, clarifies content/, and links to docs hub. |
ADDING_PAGES.md |
Adds prominent pointers to the new docs hub and the content folder guide. |
config.toml |
Deleted obsolete Hugo configuration file. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Issues use status labels such as triage/in-progress/blocked/closed | ||
| - PRs use draft/in-review/approved/changes-requested/merged/closed |
There was a problem hiding this comment.
The status label names in this doc don't match what the automation actually applies. The status-labels.yml workflow creates/applies labels like status: triage, status: in-progress, status: blocked, etc., and PR labels like status: draft, status: in-review, etc. Update this section to use the exact label strings (including the status: prefix) so contributors can search/filter the right labels.
| - Issues use status labels such as triage/in-progress/blocked/closed | |
| - PRs use draft/in-review/approved/changes-requested/merged/closed | |
| - Issues use status labels such as `status: triage`, `status: in-progress`, `status: blocked`, `status: closed` | |
| - PRs use status labels such as `status: draft`, `status: in-review`, `status: approved`, `status: changes-requested`, `status: merged`, `status: closed` |
| - Next.js App Router application (primary runtime) | ||
| - Markdown content (legacy Hugo format, still actively used for content) | ||
| - i18n routing and locale files for English and German | ||
| - GitHub Actions automation for issue/PR workflows |
There was a problem hiding this comment.
This file reintroduces a 'legacy Hugo format' reference, but the PR description says legacy Hugo references are being removed and config.toml has been deleted. Either remove the Hugo wording here or rephrase it more precisely (e.g., Markdown content with Hugo-style shortcode compatibility) so the documentation and PR intent are consistent.
|
|
||
| - **Legacy Hugo content (migrating)** | ||
| - Markdown content in `content`. | ||
| - Hugo templates in `src/layouts`. | ||
| - Hugo configuration in `config.toml`. | ||
| - **Markdown content** | ||
| - Markdown content in `content/`. | ||
| - Built static artifacts live in `public` (do not edit manually). |
There was a problem hiding this comment.
This updated section frames the repo as purely 'Markdown content', but elsewhere in README.md the intro still states that 'legacy Hugo content' is kept. With config.toml removed, the README should use consistent wording across sections (either remove the Hugo mention in the intro, or clarify that markdown remains Hugo-compatible only in specific ways like shortcode support).
This pull request introduces a comprehensive contributor documentation hub and updates the project structure references for clarity and onboarding. The main focus is to streamline the onboarding process, clarify content folder usage, and provide step-by-step guides for page addition, contribution, testing, and GitHub automation. Legacy Hugo references are removed, and new docs are added to guide contributors through every aspect of the workflow.
Documentation and onboarding improvements:
docs/README.mdas the central documentation hub, with a recommended reading order and quick commands for contributors.docs/01-repo-overview.md), content folder usage (docs/02-content-folder.md), adding pages (docs/03-adding-pages.md), first contribution checklist (docs/04-first-contribution-checklist.md), testing and quality checks (docs/05-testing-and-quality-checks.md), and GitHub automation (docs/06-github-automation.md). [1] [2] [3] [4] [5] [6]Project structure and content folder clarification:
README.mdto remove legacy Hugo references, clarify the role of thecontent/folder, and highlight the new docs hub as the first stop for contributors. [1] [2] [3]ADDING_PAGES.mdto direct first-time contributors to the docs hub and content folder guide before proceeding.Legacy cleanup:
config.tomlto reflect the migration to Next.js and markdown content.