Skip to content

docs: expand CLAUDE.md with page types, widgets, lint, and source refs#1

Merged
Rost-is-love merged 2 commits into
mainfrom
claude-md-refs
May 14, 2026
Merged

docs: expand CLAUDE.md with page types, widgets, lint, and source refs#1
Rost-is-love merged 2 commits into
mainfrom
claude-md-refs

Conversation

@Nesmeshnoy
Copy link
Copy Markdown
Contributor

Summary

Captures the rules another agent and I established while rebuilding the docs into reproducible guidance for future agents working in this repo.

  • Page types — Pillar vs Reference vs Compliance. What each must / must not include, where things live (api-reference/operations/* vs interop-apis/* vs compliance/*).
  • Source code mapsmartbox / interop / prior-auth private repos for agent reference, plus their public Docker Hub images that are OK to link from docs.
  • Aidbox docs as style and platform reference, with explicit note that docs.aidbox.app cannot be hyperlinked (the absolute-links lint blocks it).
  • Widgets — block vs self-closing shapes, explicit nesting rules (tab → tabs, step → stepper, swagger-* → swagger).
  • Swagger widget family — already supported by docs-tools but previously undocumented in CLAUDE.md.
  • Lint additionsdead-end-pages (warning, with exemption rules) and absolute-links default domains made explicit.

No changes to docs/* content — this is meta-documentation for whoever (human or agent) writes Payerbox docs next.

Test plan

  • bun lint passes (15 checks, only pre-existing warnings on docs/* from the in-flight rebuild)
  • Review readability of the new sections
  • Confirm the private-repo / public-image split is the policy we want documented

Captures rules another agent and I established while rebuilding the docs:

- Page types: Pillar vs Reference vs Compliance — what each must/must not
  include, where things live (api-reference/operations vs interop-apis vs
  compliance).
- Source code map: smartbox / interop / prior-auth private repos (agent
  reference only) plus their public Docker Hub images (OK to link from
  docs).
- Aidbox docs as style/platform reference, with explicit note that
  docs.aidbox.app cannot be hyperlinked (absolute-links lint blocks it).
- Widget shapes: block vs self-closing, explicit nesting rules
  (tab→tabs, step→stepper, swagger-* → swagger).
- Swagger widget family — present in docs-tools but previously
  undocumented in CLAUDE.md.
- Lint additions: dead-end-pages (warning, with exemptions) and
  absolute-links default domains made explicit.
@Rost-is-love Rost-is-love merged commit 1e4daa0 into main May 14, 2026
2 checks passed
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