518038dc38
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>
26 lines
682 B
YAML
26 lines
682 B
YAML
site_name: Enchantrix
|
|
site_description: Go encryption library and Trix file format
|
|
site_url: https://github.com/Snider/Enchantrix
|
|
repo_url: https://github.com/Snider/Enchantrix
|
|
repo_name: Snider/Enchantrix
|
|
docs_dir: docs
|
|
theme:
|
|
name: material
|
|
nav:
|
|
- Home: index.md
|
|
- Trix File Format: trix_format.md
|
|
- CLI Reference: cli.md
|
|
- Examples:
|
|
- Trix & Sigil Chaining: trix_and_sigils.md
|
|
- Hashing: hashing.md
|
|
- Checksums: checksums.md
|
|
- RSA: rsa.md
|
|
- PGP: pgp.md
|
|
- Standalone Sigils: standalone_sigils.md
|
|
- FAQ: faq.md
|
|
- Troubleshooting: troubleshooting.md
|
|
markdown_extensions:
|
|
- admonition
|
|
- codehilite
|
|
- toc:
|
|
permalink: true
|