Skip to content

Add principle 15: Documenteer je project effectief #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
anneschuth wants to merge 4 commits into from
Closed

Add principle 15: Documenteer je project effectief #37

anneschuth wants to merge 4 commits into from

Conversation

@anneschuth
Copy link
Member

@anneschuth anneschuth commented May 27, 2025 •
edited by ravimeijerrig
Loading

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

@anneschuth
Merge pull request #36 from MinBZK/fix/bano
44adeed 
Fix email/team references
@anneschuth anneschuth requested a review from a team as a code owner May 27, 2025 08:16
@github-actions
Copy link
Contributor

github-actions bot commented May 27, 2025 •
edited
Loading

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
TimvdLippe
TimvdLippe reviewed May 30, 2025
View reviewed changes
ravimeijerrig and others added 3 commits June 17, 2025 10:41
@ravimeijerrig @TimvdLippe
Fix indentation docs/principes/documentatie/index.md
e094e95 
Co-authored-by: Tim van der Lippe <TimvdLippe@users.noreply.github.com>
@ravimeijerrig @TimvdLippe
Fix indentation docs/principes/documentatie/index.md
c833707 
Co-authored-by: Tim van der Lippe <TimvdLippe@users.noreply.github.com>
@ravimeijerrig @TimvdLippe
Rename header docs/principes/documentatie/index.md
6c51639 
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
Copy link
Contributor

ravimeijerrig commented Sep 16, 2025 •
edited
Loading

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

Reviewers

@robbertbos robbertbos Awaiting requested review from robbertbos

1 more reviewer

@TimvdLippe TimvdLippe TimvdLippe left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@anneschuth @ravimeijerrig @TimvdLippe