Shannon — PWG technical knowledge base
Shannon is Partners Wealth Group’s technical knowledge base. System documentation, cross-cutting architecture decisions, runbooks, conventions, and glossary — all version-controlled, reviewable, and searchable.
Named for Claude Shannon, father of information theory, because most of the content is authored and maintained with Claude’s assistance against live system APIs.
Finding what you need
Section titled “Finding what you need”Use the search box (top of the sidebar) for keyword lookup across every page — powered by Pagefind, built at deploy time.
Or browse by section:
- Systems — documentation for Salesforce FSC, MYOB Advanced, XPLAN, Hex, PWG_DATA, Workato, Azure, M365. Each system follows a five-file convention: overview, architecture, integrations, admin procedures, known issues.
- Projects — documentation for active and recent initiatives that span multiple systems.
- Runbooks — cross-cutting operational procedures (incident response, on-call, access requests).
- ADRs — architecture decision records explaining why we built things the way we did.
- Reference — glossary, conventions, policies.
Requesting access
Section titled “Requesting access”Shannon is gated by Entra ID. You need the kb_reader role.
If you reached a sign-in wall and don’t have access, raise a request via the standard PWG IT access-request process. New starters in technology, data, and advice-tech roles are provisioned automatically as part of onboarding.
Contributing
Section titled “Contributing”Most contributions do not belong in this repo. System documentation lives in each system’s own source repo and is federated into Shannon at build time.
| You want to change… | PR against… |
|---|---|
| A Salesforce, MYOB, XPLAN, Hex, PWG_DATA, Workato, Azure, or M365 page | That system’s source repo. |
| A cross-cutting ADR, runbook, glossary entry, or policy | Shannon (Partners-Wealth-Group/PWG-Shannon). |
| The site theme, sidebar, or frontmatter schema | Shannon. |
| Add a brand-new system | Shannon — edit sources.yml. |
Read CLAUDE.md and .claude/CONVENTIONS.md before non-trivial changes.
Reporting a problem with a doc
Section titled “Reporting a problem with a doc”Every page has an “Edit this page on GitHub” link at the bottom. Use it. If the page is federated from another repo, the link points to the source repo, which is where the fix needs to land.