This commit addresses several gaps identified in a comprehensive documentation audit.
- Adds `AUDIT-DOCUMENTATION.md` with the full audit report.
- Adds a `CONTRIBUTING.md` to guide new contributors.
- Adds a `CHANGELOG.md` to track version history.
- Adds `docs/faq.md` and `docs/troubleshooting.md` to improve user support.
- Updates `mkdocs.yml` to include the new documentation pages.
Co-authored-by: Snider <631881+Snider@users.noreply.github.com>
This commit adds a new documentation website built with MkDocs and the Material theme.
The website includes pages for:
- Trix & Sigil Chaining
- Hashing
- Checksums
- RSA
- Standalone Sigils
A GitHub Actions workflow is also included to automatically build and deploy the site to GitHub Pages when changes are merged into the main branch.
This commit introduces a new, generic `.trix` file format, which is decoupled from any specific encryption algorithm.
The format is defined in `docs/trix_format.md` and consists of a magic number, version, a flexible JSON header, and a raw data payload.
A new `trix` Go package is implemented to handle the encoding and decoding of this format. Unit tests are included to verify the implementation.
An example file, `examples/main.go`, is also added to demonstrate how to use the `.trix` container to store data encrypted with the `chachapoly` package, showcasing the intended decoupled design.
