Starknet Agent Kit Documentation

This repository contains the documentation for the Starknet Agent Kit, built using Antora documentation framework.

Prerequisites

Before you begin, ensure you have the following installed: - Node.js (v16 or later) - npm (usually comes with Node.js) - Git

Setup Instructions

1. Clone the repository: bash git clone https://github.com/kasarlabs/sak-docs.git cd sak-docs

2. Install dependencies: bash npm install

3. Install Antora globally (this is required for the build script): bash npm install -g @antora/cli @antora/site-generator

Building the Documentation

1. To build the documentation locally: bash ./build_local_site.sh This will generate the site in the build/site directory.

2. To serve the documentation locally: bash ./server.sh The documentation will be available at http://localhost:8080

Project Structure

sak-docs/
├── components/
│   └── StarknetAgent/
│       ├── antora.yml           # Component configuration
│       └── modules/
│           ├── ROOT/            # Home page and root content
│           ├── architecture/    # Architecture documentation
│           ├── quick-start/     # Quick start guides
│           └── tools/           # Tools documentation
├── playbook.yml                 # Antora playbook configuration
├── build_local_site.sh         # Build script
└── server.sh                   # Local server script

Writing Documentation

Documentation is written in AsciiDoc format. Key files:

• components/StarknetAgent/antora.yml: Defines component metadata and navigation

• components/StarknetAgent/modules/ROOT/nav.adoc: Main navigation structure

• components/StarknetAgent/modules/ROOT/pages/index.adoc: Home page

Common Issues

1. antora: command not found

   • Solution: Install Antora globally bash npm install -g @antora/cli @antora/site-generator

2. Missing dependencies

   • Solution: Run npm install bash npm install

Contributing

1. Create a new branch for your changes

2. Make your changes

3. Test locally by building the documentation

4. Submit a pull request

Additional Resources

• [Antora Documentation](https://docs.antora.org/antora/latest/)

• [AsciiDoc Syntax Quick Reference](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/)

Need Help?

If you encounter any issues or need assistance: 1. Check the Common Issues section above 2. Create an issue in the repository 3. Reach out to the maintainers

License

MIT - KasarLabs