Build/improve ontology documentation

ccamel commented 7 months ago

Partially resolve issue https://github.com/okp4/docs/issues/407 by delivering the following elements:

A separate documentation file for each Verifiable Credential schema.
A list of all namespaces utilized by the schema.
Detailed documentation of every class defined within the schema.
Detailed documentation of all properties associated with the class as defined in the schema.
Documentation of examples, where available.

Preview:

Summary by CodeRabbit

New Features
- Introduced several new schema documentation for credentials, enhancing the understanding and application of datasets, digital resources, services, governance texts, and zones.
- Added a new output_path argument in CLI for specifying documentation generation paths.
- Implemented a structured markdown document generation from schema graphs in CLI templates.
Documentation
- Updated and expanded documentation to include comprehensive details on new and existing schemas.
Bug Fixes
- Corrected permissions setting command for Markdown files to ensure proper documentation generation.
Refactor
- Updated variable and function signatures in Makefile and CLI scripts for improved documentation generation and linting processes.
- Renamed classes and updated references in the digital resource schema for consistency.
Chores
- Enhanced CLI documentation generation capabilities with new parsing and rendering functions.

coderabbitai[bot] commented 7 months ago

[!NOTE]

Reviews Paused

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.

@coderabbitai review to trigger a single review.

Walkthrough

This update introduces a series of enhancements across the project, focusing on refining permissions for Markdown files, improving Makefile configuration for documentation, expanding the ontology with new credentials schemas, and refining CLI scripts for better documentation generation. It aims to make the project's documentation more comprehensive, organized, and accessible, while also ensuring that the schemas are correctly represented and deployed.

Changes

Files	Summary
`.github/workflows/lint.yml`	Updated permissions command for Markdown files in `docs`.
`Makefile`	Added `DTS_DOCS_SCHEMAS` variable; updated targets for schema documentation.
`docs/schemas/...`	Introduced new schemas for various credentials, enhancing ontology documentation.
`script/cli/cli.py`	Updated `generate` function signature; added new option for documentation.
`script/cli/documentation.py`	Improved documentation generation logic and added new functions.
`script/cli/templates/schema.md.j2`	Template for generating structured markdown documents from schema graphs.
`src/schema/digital-resource/credential-digital-resource-rights.ttl`	Renamed class and updated properties to correct domain references.

Related issues

okp4/ontology#214: The addition of new schemas and improvements in documentation generation align with the objectives of incorporating Verifiable Credentials and ensuring schemas' URIs are resolvable.
okp4/ontology#76: The enhancements in documentation generation directly contribute to the objective of providing comprehensive markdown documentation for the ontology.
okp4/docs#407: The creation of one page per VC schema and the addition of properties and examples address the objectives of making the documentation more user-friendly and comprehensive.

Poem

In the digital realm, where data weaves and bends,
A rabbit hopped in, making amends.
With a flick of its paw and a twitch of its nose,
New schemas were planted, and documentation grows. 🐰📚✨
"To organize, to clarify," it whispered with glee,
"For a world more connected, as it ought to be."

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.

ccamel commented 7 months ago

@coderabbitai pause

bot-anik commented 6 months ago

:tada: This PR is included in version 3.0.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

axone-protocol / ontology