A tool for integrating rights, caring practices, and other human-rentric concepts into software engineering. Going beyond docs-as-code, we can use it to practice docs-for-better-code.
Important
The code in this repository is under active development and currently only provides the most basic proof-of-concept functionality. It will be a few more months (as of mid-September 2024) before it stabilises and this becomes usable as a tool. I am exposing it here, though, to inspire discussion about both the project aims and about the general approach to implementation.
in no particular order...
-
Independent of any specific static site generator - works with Material for MkDocs, Readthedocs, plain MkDocs, Hugo, Docusaurus, even Pandoc!
-
Dialect agnostic - passes through all Markdown, replacing only specific code blocks with HTML elements that are rendered as part of Markdown by the tools listed above.
-
Renders BDD feature files written in Gherkin.
-
Renders formulations of rights
-
Renders caring practices
-
Renders formulations of the UN Sustainable Development Goals
-
Produces analyses that show you where rights still need to be implemented, what design decisions observed caring practices have inspired, what sustainability goals have been taken into consideration.
-
Documentation produces with Torshi provides a basis for sustainability reporting, as required by, for example, the EU's Corporate Sustainability Reporting Directive.
- Written in Rust for performance and to help with quality
- Extensive set of unit tests
- Examples that double as end-to-end tests