Skip to content

Add README.md, man pages, and XML command reference - #10

Merged
sindoc merged 1 commit into
mainfrom
claude/add-documentation-docs1
Mar 25, 2026
Merged

sindoc merged 1 commit into
mainfrom
claude/add-documentation-docs1

Conversation

@sindoc

@sindoc sindoc commented Mar 25, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • README.md — comprehensive project overview: architecture, quick start, all components, full command reference, repo layout, Java integrations, vocabulary alignment
  • docs/man/ — five groff man pages installable via man:
    • singine-collibra.1 — top-level overview and shared env vars
    • singine-collibra-edge.1 — edge stack (build, setup, deploy, k8s, agent)
    • singine-collibra-id.1 — ID generation and namespace registry
    • singine-collibra-contract.1 — contract lifecycle and 7-step pipeline
    • singine-collibra-server.1 — HTTP server (net/dmz modes)
  • docs/xml/singine-collibra-commands.xml — XML command surface (all components, options, choices, examples)
  • docs/xml/singine-collibra-model.xml — domain model (contract IDs, data contracts, edge stack, vocabulary alignment)

Test plan

  • man -l docs/man/singine-collibra.1 renders correctly
  • man -l docs/man/singine-collibra-edge.1 renders correctly
  • XML files are well-formed: xmllint --noout docs/xml/*.xml
  • README.md links and code blocks render on GitHub

🤖 Generated with Claude Code

- README.md: comprehensive project overview with architecture, quick
  start, all components, command reference, and repo layout
- docs/man/: five groff man pages (singine-collibra.1,
  singine-collibra-edge.1, singine-collibra-id.1,
  singine-collibra-contract.1, singine-collibra-server.1)
- docs/xml/singine-collibra-commands.xml: full XML command surface
  with all options, choices, examples, and endpoint tables
- docs/xml/singine-collibra-model.xml: domain model XML for contract
  IDs, data contracts (7-step pipeline), edge stack, and vocabulary
  alignment

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@sindoc
sindoc merged commit 12b2f80 into main Mar 25, 2026
4 of 7 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.

1 participant