Skip to content

docs(#32): documentation contribution guide and refactor assets #33

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

SaintierFr
Copy link
Member

  • Introduced a comprehensive guide for contributing to the documentation. Refactored assets by organizing images under assets/images and updated references. Added parameters.md for API reference and minor README adjustments for improved clarity.
  • All Sphinx-related files under the doc directory have been deleted, including configuration, index, and content files.
  • Doc have been migrated to mkdoc format

@SaintierFr SaintierFr self-assigned this Apr 14, 2025
- Introduced a comprehensive guide for contributing to the documentation. Refactored assets by organizing images under `assets/images` and updated references. Added `parameters.md` for API reference and minor README adjustments for improved clarity.
- All Sphinx-related files under the `doc` directory have been deleted, including configuration, index, and content files.
- Doc have been migrated to mkdoc format

Signed-off-by: SaintierFr <[email protected]>
@SaintierFr SaintierFr force-pushed the doc/#32/update-documentation-and-contributing/from_main branch from 42feb3a to 448a4d4 Compare April 14, 2025 12:01
@SaintierFr SaintierFr linked an issue Apr 14, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation and favorise contribution
1 participant