Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

tburny
Copy link
Collaborator

@tburny tburny commented Mar 17, 2025

As discuessed in on Discord this pull request adds a documentationType property to each documentation file that corresponds to the diataxis type of documentation.

I tried to decide on the YAML naming conventions, but Vitepress frontmatter endorses camelCase here: https://vitepress.dev/guide/frontmatter

One minor thought is documentationType vs documentationKind vs documentationCategory. See https://dictionary.cambridge.org/de/grammatik/britisch-grammatik/sort-type-and-kind for a distinction:

Sort, type and kind all generally mean the same thing. They are words we use to refer to a group of people or things which share the same characteristics.
[...]
We often use and that kind of thing or and that sort of thing to refer to categories.

tburny added 2 commits March 17, 2025 23:16
Add a `documentationType` property that references to the Diataxis type of documentation.
Diataxis recommends different styles and language guidelines for each type.
By documenting the intended type of documentation for each file, the intention becomes clear for other contributors.
Copy link
Collaborator

@oskardudycz oskardudycz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Sounds good to me 👍

@oskardudycz oskardudycz added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 18, 2025
@oskardudycz oskardudycz added this to the 0.35.0 milestone Mar 18, 2025
@oskardudycz oskardudycz merged commit 2bcb8ce into event-driven-io:main Mar 18, 2025
1 check passed
@tburny tburny deleted the docs/add-documentation-type branch March 18, 2025 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants