Skip to content

created wiki user docs for this project#24

Merged
lcorrigan704 merged 1 commit into
mainfrom
docs/add-user-documentation-to-wiki
Apr 5, 2026
Merged

created wiki user docs for this project#24
lcorrigan704 merged 1 commit into
mainfrom
docs/add-user-documentation-to-wiki

Conversation

@lcorrigan704

Copy link
Copy Markdown
Owner

Summary

  • Added a full repo-first GitHub Wiki documentation system for end users/operators.
  • Documented all current app workflows, including multi-workspace behavior, tax, multi-entity emails, adjustments, backups, and danger-zone flows.
  • Added tooling to validate docs quality and sync repo markdown to the GitHub Wiki repo.

Changes

  • Added wiki source-of-truth under docs/wiki/:
    • Core pages: Home, Getting Started, Navigation + FY filter, Onboarding/Auth.
    • Feature pages: Workspaces, Clients, Invoices, Quotes, Revenue Adjustments, Service Agreements, Proposals, Expenses.
    • Operations pages: Emails Workspace, Tax Workspace, Settings, Danger Zone.
    • Support pages: Troubleshooting/FAQ, Operations Runbook.
    • Governance pages: Documentation Standards, Docs Freshness.
  • Added templates:
    • docs/wiki/_templates/task-guide.md
    • docs/wiki/_templates/reference.md
  • Added nav manifest:
    • docs/wiki/nav.json
  • Added generated index:
    • docs/wiki/INDEX.md
  • Added docs workflow readme:
    • docs/wiki/README.md
  • Added wiki asset conventions:
    • docs/wiki/assets/README.md
  • Added scripts:
    • scripts/wiki-build-index.sh (generate index from nav)
    • scripts/wiki-validate.sh (required sections + local link checks; rg/grep compatible)
    • scripts/wiki-sync.sh (dry-run/sync/push to wiki repo; generates _Sidebar.md)
  • Added CI workflow:
    • .github/workflows/wiki-docs-check.yml
  • Updated PR template checklist to enforce docs hygiene:
    • .github/pull_request_template.md

Validation

  • Ran:
    • bash scripts/wiki-build-index.sh
    • bash scripts/wiki-validate.sh
    • bash scripts/wiki-sync.sh --dry-run
  • Result:
    • Docs validation passed.
    • Wiki sync dry-run passed and listed expected pages/assets/sidebar output.

Screenshots (if UI changes)

  • No application UI changes in this PR.
  • Documentation-only change.

Risks / Notes

  • Wiki publishing requires the GitHub Wiki repo to be enabled and initialized.
  • Sync script expects a local clone of the wiki repo path passed via --wiki-dir.

Checklist

  • I have tested these changes locally
  • I have updated documentation where needed
  • I reviewed docs impact and updated impacted pages under docs/wiki/
  • I updated docs/wiki/Docs-Freshness.md (or marked N/A with reason)
  • I ran bash scripts/wiki-validate.sh locally (or CI covers this)
  • I have considered migrations or data impacts (N/A - docs/tooling only)

@lcorrigan704 lcorrigan704 linked an issue Apr 5, 2026 that may be closed by this pull request
@lcorrigan704 lcorrigan704 merged commit 6a7043b into main Apr 5, 2026
1 check passed
@lcorrigan704 lcorrigan704 deleted the docs/add-user-documentation-to-wiki branch April 5, 2026 13:35
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.

[Feature]: Add user documentation

1 participant