Scheme for documentation #201

Open
opened 2026-02-17 11:53:18 -06:00 by GiteaMirror · 0 comments
Owner

Originally created by @ooker777 on GitHub (Mar 2, 2024).

I'm inspired by Conventional Commits, and would like to have a scheme for writing projects, e.g. documentations or personal or organizational knowledge management system. It's like how Semantic Versioning for Documents be to Semantic Versioning. I'm thinking of using these structure elements:

  • title: for changes in project title
  • structure: for changes in project folder structure
  • fileA/B/C: for changes in an important file (to avoid to tediously create many submodules for tracking many individual files)

Do you have any feedback?

Originally created by @ooker777 on GitHub (Mar 2, 2024). I'm inspired by Conventional Commits, and would like to have a scheme for writing projects, e.g. documentations or personal or organizational knowledge management system. It's like how [Semantic Versioning for Documents](https://semverdoc.org/ "Semantic Versioning for Documents and Meaningful Manual Version Control | SemVerDoc") be to [Semantic Versioning](https://semver.org/ "Semantic Versioning 2.0.0 | Semantic Versioning"). I'm thinking of using these structure elements: - **title:** for changes in project title - **structure:** for changes in project folder structure - **fileA/B/C:** for changes in an important file (to avoid to tediously create many submodules for tracking many individual files) Do you have any feedback?
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#201