Skip to content

docs: audit and format documentation for public release#2

Merged
ncurrie3 merged 1 commit intomainfrom
docs/audit-and-formatting
Mar 13, 2026
Merged

docs: audit and format documentation for public release#2
ncurrie3 merged 1 commit intomainfrom
docs/audit-and-formatting

Conversation

@ncurrie3
Copy link
Copy Markdown
Member

Public Release Documentation Audit and Formatting

This PR prepares the Stellar Engine documentation for public release by adding required authorization documents and fixing Markdown formatting issues

Changes Included

  • New Documentation: Added the following authorization and best practice guides to the docs/ directory:
    • docs/ddg.md (Deployment Design Guide)
    • docs/path-to-authorization.md
    • docs/scc-deployment-guide.md
    • docs/security-best-practices.md
    • docs/tdd.md (Technical Design Document)
  • Formatting Fixes:
    • Corrected <variable> formatting in docs/ddg.md where variables were previously unescaped and hidden in Markdown previews.
    • Fixed incorrect bolding and mismatched escaped asterisks (\*) in docs/security-best-practices.md and docs/path-to-authorization.md.
    • Cleaned up lingering TODO items in blueprints/il5/bq-project/README.md and fast/stages-aw/0-bootstrap/README.md.

@ncurrie3 ncurrie3 requested a review from aghassemlouei March 13, 2026 20:56
@ncurrie3 ncurrie3 self-assigned this Mar 13, 2026
@ncurrie3 ncurrie3 added the documentation Improvements or additions to documentation label Mar 13, 2026
@ncurrie3 ncurrie3 merged commit 63b2a1d into main Mar 13, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant