Skip to content

Conversation

@Snider
Copy link
Owner

@Snider Snider commented Nov 3, 2025

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 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.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 3, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Summary by CodeRabbit

Release Notes

  • Documentation

    • Added comprehensive guides covering Trix & Sigil Chaining, hashing, checksums, RSA encryption, and standalone sigils.
    • Published Enchantrix documentation with Trix File Format overview and examples.
  • Chores

    • Configured GitHub Pages publishing for documentation.

Walkthrough

Establishes documentation infrastructure for the Enchantrix Go-based cryptographic library by introducing MkDocs configuration, automated GitHub Pages publishing workflow, and seven documentation pages demonstrating cryptographic operations including hashing, checksums, RSA encryption, and sigil chaining.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow
.github/workflows/mkdocs.yml
Adds automated publishing workflow triggering on main branch pushes, deploying MkDocs documentation to GitHub Pages using Python 3.x and mkdocs-material theme
MkDocs Configuration
docs/mkdocs.yml
Defines site metadata, theme settings, and navigation structure with Home, Trix File Format, and Examples sections linking to documentation pages
Documentation Pages
docs/docs/index.md, docs/docs/trix_and_sigils.md, docs/docs/hashing.md, docs/docs/checksums.md, docs/docs/rsa.md, docs/docs/standalone_sigils.md
Introduces six documentation files containing Go code examples demonstrating Enchantrix features: library overview, payload encryption with sigil chaining, hash algorithm usage, checksum validation, RSA key pair operations, and standalone sigil transformations

Poem

🐰 Documentation blooms, so fair and bright,
With examples dancing in the light,
From checksums to sigils, from RSA's might,
Enchantrix's secrets now take flight,
In pages of magic, both tested and right!

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-mkdocs-website

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3ab55c9 and 209b2e3.

📒 Files selected for processing (8)
  • .github/workflows/mkdocs.yml (1 hunks)
  • docs/docs/checksums.md (1 hunks)
  • docs/docs/hashing.md (1 hunks)
  • docs/docs/index.md (1 hunks)
  • docs/docs/rsa.md (1 hunks)
  • docs/docs/standalone_sigils.md (1 hunks)
  • docs/docs/trix_and_sigils.md (1 hunks)
  • docs/mkdocs.yml (1 hunks)

Comment @coderabbitai help to get the list of available commands and usage tips.

@Snider Snider merged commit 1f7fae7 into main Nov 3, 2025
1 of 2 checks passed
@Snider Snider deleted the add-mkdocs-website branch November 3, 2025 01:04
@codecov
Copy link

codecov bot commented Nov 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants