👋 Welcome in! 👋
This repository contains the Open Source code for gliff.ai’s SUPPORT supporting library (built using the Just The Docs Jekyll template).
SUPPORT is gliff.ai's user documentation for supporting use of our user-friendly interface for curating, annotation and collaborating with imaging datasets for the purposes of developing imaging AI products. When the full gliff.ai platform is used, SUPPORT provides a clear guide for our users to support the development of high-quality and auditable datasets that aid compliance with regulatory frameworks, enabling our users to build world-changing and trustworthy AI models and products.
A preview build of the current main branch is here.
✅ We welcome contributions on this repository! ✅
Looking for something specific? 🔍
install npm dependencies for lint and format with npm i --include=dev.
For further info on npm, please visit https://www.npmjs.com/.
npm should always be used for package management.
Run npm run start to get local access. Next, head to http://127.0.0.1:3000/ and then hit ctrl+c to stop the server.
Don't forget to regularly update dependencies with bundle update and npm update.
Note: HTML + CSS, mark-up and mark-down code should be formatted using Prettier but do not need to be linted.
We recommend that you use globbing to lint all markdown files in the project. To do this, please replace the line "lint:md" in the package.json file with "lint:md": "npx markdownlint-cli --ignore node_modules ./*/.md".
npm run lint will lint the codebase.
npm run format will format the codebase.
Our GitHub Actions will also lint any pull requests before they're merged.
Once code alterations have been made, please ensure the validity and stability of the code. We use Docusaurus using command 'npm run build' or 'npm run start' for continuous visualisation.
GitHub Actions should only be included under the .github/workflows path.
We welcome all contributors and any contributions on this project through the likes of feedback on or suggesting features and enhancements, raising bug problems, reporting on security vulnerabilities, reviewing code, requesting or creating tests, user testing etc. to ensure gliff.ai can help enable the best and biggest positive impact possible.
Sounds good and want to contribute to the project? 🧑💻
Please check the gliff.ai Contribution Guide 👋 before you get started.
Don’t forget the gliff.ai Code of Conduct
A big thank you from the entire gliff.ai team to these fellow contributors (emoji key):
{{Contributor List - coming soon}}
Need some help? 🤔 Have a question? 🧠
Reach out to the gliff.ai team at [email protected] or on our GitHub discussions.
This code is licensed under a GNU AGPLv3 license 📝
Curious about our reasoning for this? Read about them here!