Add documentation on organizing concepts - #213
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds comprehensive documentation on organizing concepts in the Voc4Cat vocabulary by introducing a new "Organizing Concepts" page that explains the correct use of semantic relations (IS-A, HAS-A, PART-OF) and links it from the documentation structure.
- Adds a new documentation page (
organizing-concepts.md) explaining hierarchies, relations, and collections - Integrates the new page into the documentation sidebar navigation
- Adds a tip in the guidelines page linking to the new organizing concepts documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/index.md | Adds "Organizing Concepts" entry to the "For Users" toctree navigation |
| docs/docs_usage/organizing-concepts.md | New comprehensive page detailing IS-A, HAS-A, and PART-OF relations with examples, anti-patterns, and Voc4Cat top-concepts |
| docs/docs_usage/guidelines.md | Adds a tip box referencing the new organizing concepts page for hierarchy guidance |
dalito
commented
Nov 18, 2025
Collaborator
|
It is a very useful addition especially with the examples of what not to do. We should point the "Collections" option out more in future presentations of ours for specific needs. |
- don't duplicate PR summary - review concept organization/hierarchy
nmoust
approved these changes
Nov 18, 2025
Member
|
The new documentation document is looking good |
github-project-automation
Bot
moved this from In progress
to Completed
in Voc4Cat cross-repo view
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds more documentation to clarify how to organize concepts and structure hierarchies in the Voc4Cat vocabulary. It introduces a new page detailing the distinctions between IS-A, HAS-A, and PART-OF relations, and how each should be modeled. This should help users applying semantic relations correctly and keep the Voc4Cat structure clean.
organizing-concepts.md, that explains best practices for organizing concepts in Voc4Cat, including anti-patterns and top-level concept concepts.guidelines.md) referencing the new "organization of concepts" page.@HendrikBorgelt & @nmoust - looking forward to your comments.
Closes #175