Skip to content

docs: add Getting Started guide with step-by-step walkthrough#29

Open
AWaterColorPen wants to merge 2 commits intomainfrom
feature/phase2-getting-started
Open

docs: add Getting Started guide with step-by-step walkthrough#29
AWaterColorPen wants to merge 2 commits intomainfrom
feature/phase2-getting-started

Conversation

@AWaterColorPen
Copy link
Copy Markdown
Owner

Summary

Phase 2 first task: Rewrite Getting Started with a complete step-by-step guide.

Changes

  • New docs/getting-started.md — 600-line comprehensive guide covering:
    • Core concepts overview (User, Role, Object, Domain, Policy)
    • Step 1: Install
    • Step 2: Implement the four core types (with full code samples)
    • Step 3: Create a dictionary config (TOML with explanation table)
    • Step 4: Initialize the service
    • Step 5: Bootstrap a domain (CreateDomain, ResetDomain, ResetFeature)
    • Step 6: Manage users and roles (assign, list, inspect)
    • Step 7: Permission checks (AuthBackend, AuthFrontend, GetFeature, SetCurrent)
    • Step 8: Use the playground package for testing
    • Complete self-contained runnable example program
  • Updated README.md — added Getting Started to the documentation table

Part of

Phase 2 documentation buildout (2026-03-10 modernization plan).

- New docs/getting-started.md: complete guide covering all steps from
  install to running permission checks
- Covers: type implementation, dictionary config, service init,
  domain bootstrap, user/role management, permission checks,
  SetCurrent scoped API, and playground usage for tests
- Includes complete self-contained runnable example program
- Updates README.md documentation table to include the new guide

Part of Phase 2 documentation buildout.
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.

1 participant