HSSI Documentation¶
Documentation for this project lives in docs/ and is published to the
documentation site
on every push to main. To change it, open a pull request against docs/.
Contents¶
Getting Started¶
- Getting Started — clone the repo, set up your environment, and get a local instance running.
Understanding the Project¶
- Architecture — the system's shape and the design rationale behind its non-obvious patterns.
- Glossary — domain and project-specific terminology used throughout this codebase and its docs.
Reference¶
- API Reference — the HTTP API exposed by the HSSI website: software catalog, search, submission, and update endpoints.
- Code Reference — the codebase's internals: data model, submission workflow, frontend architecture, admin/curation tooling, and deployment configuration.