The ST team is happy to announce a new release of the ST documentation, tag v0.1.0, which is the first release. The documentation is available as git repository:
https://git.glasklar.is/system-transparency/project/docs
and as a deployed homepage at:
https://docs.system-transparency.org/
The expectations and intended use of the st docs is documented in the repository's RELEASES file. This RELEASES file also contains more information concerning the overall release process, see:
https://git.glasklar.is/system-transparency/project/docs/-/blob/main/RELEASE...
Learn about what's new in a release from the repository's NEWS file. An excerpt from the latest NEWS-file entry is listed below for convenience.
https://git.glasklar.is/system-transparency/project/docs/-/blob/main/NEWS.md
If you find any issues, please open an issue or MR at the documentation repository.
Cheers, The ST team
NEWS for docs v0.1.0
We are excited to announce the initial release of ST Documentation, version v0.1.0. This release marks a significant milestone in our journey to provide comprehensive and user-friendly documentation for the ST ecosystem. It's important to note that this version is the first step in our ongoing effort to develop and refine our documentation. It is an early release that sets the foundation for future improvements and expansions.
### Key Highlights of v0.1.0
- Quickstart Guide: To help new users get up and running, we've included a Quickstart Guide. This guide is designed to provide a straightforward introduction to the ST ecosystem, making it easier for newcomers to start their journey. - Interface Documentation: We've meticulously documented the interfaces within the ST ecosystem. This includes detailed descriptions of functions, classes, and modules, providing a valuable resource for both developers and users seeking a deeper understanding of the system's internals. Still some interfaces might be missing and added lat - Learn More Resources: For those who wish to dive deeper, we've added a "Learn More" section. Here, you'll find resources and materials that cover various aspects of the ST ecosystem in more detail, perfect for users who wish to expand their knowledge and skills.
## A Note on Stability
Please note that v0.1.0 is not meant to be a stable release. It's the beginning of a iterative process, and as such, we expect to make frequent updates and improvements. Users should be prepared for changes and enhancements in subsequent releases. We're committed to rapidly evolving and updating our documentation to meet the needs of our community.
### Future Plans
- Regular Updates: We will be regularly releasing updates to improve and expand our documentation. - Community Feedback: We strongly encourage feedback from our users. Your insights are invaluable in helping us refine and enhance our documentation. - Expanding Content: Expect to see more tutorials, in-depth guides, and comprehensive reference materials in future releases.
## Getting Involved
The ST Documentation is a community-driven project, and we welcome contributions from everyone. Whether it's providing feedback, reporting issues, or contributing content, your involvement is what makes this project grow and improve.
### Stay Updated
To keep abreast of the latest developments and upcoming releases, please follow our project's channels and stay connected with the community.
We thank you for your support and interest in ST Documentation. Let's make it a robust and valuable resource together!