This repository contains open-source documentation for products made by Kagi Inc.
This repo serves documentation for multiple products developed by Kagi.
| Product | Documentation | Repo Directory |
|---|---|---|
| Kagi Search | https://help.kagi.com/kagi | kagi |
| Orion Browser | https://help.kagi.com/orion | orion |
Our documentation efforts are ongoing! We welcome your feedback and contributions - read on for details!
On our discussions page, you will find several categories:
-
Announcements, where we will post important updates related to the documentation in this repo.
-
Q&A, where you can discuss and ask questions about the documentation and APIs that we offer. This is the best place to start if you're not sure of a better place!
For topics outside of the documentation & APIs, please refer to that product's official support venues, in the Community section.
Each of our products has their own budding community. You can join us for wider discussion and product support at their dedicated venues:
| Product | Feedback & Bug Reports | Discord |
|---|---|---|
| Kagi Search | kagifeedback.org | Invite Link |
| Orion Browser | orionfeedback.org | Invite Link |
We welcome any bug reports, requests for clarification, or other inquiries via the Issues tab.
Upon opening an issue, you will be presented with a list of templates to choose from that will help you provide us with the information we need, and triage the issue with the correct labels.
A staff member will review your issue, and help investigate what the best course of action is.
Thank you for taking the time to contribute!
We welcome contributions such as:
- Fixes to incorrect statements or inaccuracies within the documentation.
- Extending documentation with details, or clarifying complicated explanations with easier to understand wording.
- Additions that fill gaps or missing pieces in the current documentation.
- Fixing of spelling and grammatical errors in the documentation.
- Adding new documentation when staff calls on the community to prepare new sections.
We would ask that you withhold:
- Whitespace or formatting changes.
- Subjective wording changes.
- Modifications to the overall structure and format of the documentation.
- Additions needlessly restructure current documentation.
- Additions that document unreleased product functionality.
If you are not sure, please feel free to open an issue first, and we will help guide you along!
- Create a fork of this repo
- Create a branch:
git checkout -b username/my-cool-change - Follow the Building instructions to compile the book you would like to change
- Make your changes - ensure everything looks good when compiled with mdBook!
- Commit your changes:
git -am 'Update documentation' - Push the branch to your fork:
git push origin username/my-cool-change - Create a new Pull Request
A template in the pull request form will guide you in providing any additional details we need to help accept your changes.
All documentation is written to be hosted with the open-source mdBook documentation utility.
Each directory in the Knowledgebase Map is built as its own book, configured for that products own criteria, look, and feel.
To get started:
- Install mdBook
- Navigate to the book you wish to build in the Knowledgebase Map
- Run
mdbook buildin that directory to compile the book to abook/directory with the rendered contents
You can also run mdbook serve and open http://localhost:3000
to view the documentation in your browser. mdBook will watch your files and automatically
rebuild & refresh the page when the book's files are updated.
See each book's book.toml for configuration options we have applied.