README.md

Akri Docs

This repo contains documentation for Akri, including:

1. Akri's user and developer docs, which are hosted Akri's docs site docs.akri.sh by GitBook
2. Proposals for new Akri features
3. Akri's logo artifacts

Adding Documentation

To add documentation to Akri's GitBook documentation site, create a markdown file in the appropriate section folder within docs.

Akri's documentation is divided into six sections:

1. 📘 User Guide: Documentation for Akri users.
2. 🔎 Discovery Handlers: Documentation on how to configure Akri using Akri's currently supported Discovery Handlers
3. 🚀 Demos: End-to-End demos that demostrate how Akri can discover and use devices. Contain sample brokers and end applications.
4. ⚙️ Architecture: Documentation that details the design and implementation of Akri's components.
5. 💻 Development: Documentation for Akri developers or how to build, test, and extend Akri.
6. 🎉 Community: Information on what's next for Akri and how to get involved!

Then, link to it in SUMMARY.md to ensure it is displayed on Akri's site.

Add associated images to the media folder and adhere to GitBook Markdown syntax requirements.

Creating a Proposal

To propose a design for a new Akri feature such as a new Discovery Handler, create a PR to add your document to the proposals folder. A proposal template and conventions for updating proposal statuses will be added soon.

Other Documentation

HackMD

If you have guides, scenarios, examples, etc. that you think would benefit from being a part of the Akri ecosystem but do not fit on Akri's documentation site or as a proposal, they could be added to Akri's HackMD. Create an issue to request that a HackMD page be created for the content.

Akri's Medium Blog

If you have a scenario or use-case you'd like to share more broadly, we are always looking for contributions to Akri's Medium Blog.

The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page