Skip to content
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

Declare the documentation mode of each markdown page #248

Closed
duncandewhurst opened this issue Jan 22, 2023 · 1 comment · Fixed by #282
Closed

Declare the documentation mode of each markdown page #248

duncandewhurst opened this issue Jan 22, 2023 · 1 comment · Fixed by #282
Assignees
@odscjen
Labels
Non-normative documentation Normative documentation

Comments

@duncandewhurst
Copy link
Collaborator

From evildmp/diataxis-documentation-framework#26:

The intention would be to hint to editors which type of documentation the page is aiming to be, so that they don't inadvertently start adding explanation to a reference page.
@odscjen odscjen self-assigned this May 23, 2024
@odscjen
Copy link
Collaborator

odscjen commented May 23, 2024

All files in the docs/ folder:

file(s) doc type
reference/ reference
history/ reference
support/index.md reference
primer/ explanation
guidance/ how-to-guides
index.md explanation
governance reference

@odscjen odscjen mentioned this issue May 23, 2024
Merged
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@odscjen odscjen

Labels
Non-normative documentation Normative documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

248: add comment to md files declaring document mode Open-Telecoms-Data/open-fibre-data-standard
2 participants
@duncandewhurst @odscjen