Skip to content

Add principle 15: Documenteer je project effectief#37

Closed
anneschuth wants to merge 4 commits into
old-mainfrom
issue-28
Closed

Add principle 15: Documenteer je project effectief#37
anneschuth wants to merge 4 commits into
old-mainfrom
issue-28

Conversation

@anneschuth

@anneschuth anneschuth commented May 27, 2025

Copy link
Copy Markdown
Member

Summary

  • Implements GitHub issue Toevoegen richtlijn voor documentatie #28 by adding comprehensive guidance on project documentation tools and frameworks
  • Adds principle 15 with detailed comparison of MkDocs, Docusaurus, Sphinx, Structurizr, and ReSpec
  • Recommends Material for MkDocs as the preferred solution ("gebaande paden") for Dutch government projects

Test plan

  • Verify new documentation principle appears correctly in navigation
  • Check that all internal links work properly
  • Ensure markdown formatting displays correctly
  • Validate that the principle count is updated to 15 throughout the site

🤖 Generated with Claude Code

Fix email/team references
@anneschuth anneschuth requested a review from a team as a code owner May 27, 2025 08:16
@github-actions

github-actions Bot commented May 27, 2025

Copy link
Copy Markdown
Contributor
PR Preview Action v1.6.1

🚀 View preview at
https://MinBZK.github.io/NeRDS/pr-preview/pr-37/

Built to branch gh-pages at 2025-06-17 08:42 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@anneschuth anneschuth requested a review from robbertbos May 27, 2025 08:16
Comment thread docs/principes/documentatie/index.md Outdated
Comment thread docs/principes/documentatie/index.md Outdated
Comment thread docs/principes/documentatie/index.md Outdated
ravimeijerrig and others added 3 commits June 17, 2025 10:41
Co-authored-by: Tim van der Lippe <TimvdLippe@users.noreply.github.com>
Co-authored-by: Tim van der Lippe <TimvdLippe@users.noreply.github.com>
Co-authored-by: Tim van der Lippe <TimvdLippe@users.noreply.github.com>
@ravimeijerrig ravimeijerrig deleted the branch old-main September 16, 2025 11:20
@ravimeijerrig ravimeijerrig deleted the issue-28 branch September 16, 2025 11:20
@ravimeijerrig ravimeijerrig restored the issue-28 branch September 16, 2025 11:22
@ravimeijerrig

ravimeijerrig commented Sep 16, 2025

Copy link
Copy Markdown
Contributor

Accidentally closed this PR when organising the branches of this repo. The issue is still open and will be picked up in #118

@ravimeijerrig ravimeijerrig deleted the issue-28 branch February 4, 2026 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants