This repository is used to store the knowledgebase files for Noxity. The knowledgebase is powered by Mintlify which pulls all content directly from this repository. The knowledgebase is available here.
Contributions to this project are currenly limited to Noxity staff only. Thus these instructions serve informational purpose only to the public. Soon we plan to open issue and suggestion system for everyone.
To get started message project leader on Discord to be added to the knowledgebase team. After a team leader has added you to the team you can start editing the knowledgebase.
- Clone the repository to your local machine.
- Open the repository with Visual Studio Code or other IDE.
- You always push to writing branch.
- If doesn't exist already, create a writing branch from the
mainbranch. - Make your changes to the knowledgebase.
- Commit your changes to writing branch.
- Create a pull request to the
mainbranch. - Wait for a project maintainer to review your changes.
- The knowledgebase uses formatting available here: https://help.noxity.io/essentials/markdown
- If you are using Visual Studio Code, we recommend setting syntax checker to "HTML" for .mdx files within this project. This will help you see any errors in your formatting.
- Change background to something more dynamic
- Find nice gradient for anchor icon links
- Fix purpleish glow on button hover and search popup. Replace it with Noxity red
- Since local changes aren't working (needs to be fixed by Mintlify) setup another instance for development and writing.
- Fix card links opening in a new tab
- Add a "back to top" button
- Add icons to "tabs" in the header if loaded from mobile (currently they all show the same icon)
- Add crisp ive chat to the knowledgebase
- Add github link to the knolwedgebase in the header - DONE ✅
- Open source the knowledgebase system - DONE ✅
- Add icons to sidebar links - DONE ✅
- Implement "raiseIssue" + setup GitHub to allow these requests - DONE ✅
- Implement "og:image" in the head section of each article
- Custom colored icons on cards (Example: https://infisical.com/docs/documentation/getting-started/introduction)
- Custom images on cards (https://docs.propelauth.com/reference/overview)
- Add emojis / icons to the article navigation guide and be funny with GIFs (https://docs.mage.ai/data-integrations/overview)
- Investiate "ultraLight" & "ultraDark" configuration options
We would like to acknowledge the following projects for their contributions:
- Mintlify - Knowledgebase system
- Inspiration - The extent of available possibilities and features with Mintlify wouldn't be possible without the showcases of other projects.
This project itself (knowledgebase system) is free and open-source software provided by Mintlify, but we reserve all rights to our content and own modifications.