Katana Documentation

Welcome to Katana Documentation!

These docs use the Material theme for MkDocs. Our goal is to establish a high-quality, curated, and comprehensive "source of truth" for Katana.

Run locally

Prerequisites

1. uv
2. Python 3.13, installed either through uv or independantly.

Setup

1. Clone the repository.
2. Install project dependencies with uv sync --locked --dev.
3. Run uv run mkdocs serve to start the mkdocs development server.

Contributing

Getting started

1. Fork and branch: Fork the main branch into your own GitHub account. Create a feature branch for your changes.
2. Make changes: Implement your changes or additions in your feature branch.
3. Contribution quality: Ensure that your contributions are:
   • Atomic: Small, self-contained, logical updates are preferred.
   • Well documented: Use clear commit messages. Explain your changes in the pull request description.
   • Tested: Verify your changes do not break existing functionality.
   • Styled correctly: Follow the Microsoft Style Guide.

Creating a pull request

1. Pull request: Once your changes are complete, create a pull request against the main branch of the Agglayer Documentation.
2. Review process: Your pull request will be reviewed by the maintainers. They may request changes or clarifications.
3. Responsibility: Contributors are expected to maintain their contributions over time and update them as necessary to ensure continued accuracy and relevance.

Best practices

• Stay informed: Keep up-to-date with the latest developments with the Agglayer.
• Engage with the community: Participate in discussions and provide feedback on other contributions.
• Stay consistent: Ensure your contributions are coherent with the rest of the documentation and do not overlap or contradict existing content.

Contact and support

• For docs issues (technical or language) open an issue here.