# Pivograph

> Pivograph maps an organization's projects, platforms, data and partners as a graph (nodes and directed edges) from one JSON document, rendered and edited in the browser with Pivotick. It imports Open Contributions Descriptors (.well-known/open-contributions.json) and can be embedded in other sites.

To map an organization, read the full documentation first and follow its "Mapping an organization" procedure and "Document format" reference exactly.

## Docs

- [Full documentation](https://ecrou-exact.github.io/project-graph/llms-full.txt): everything below in one Markdown file
- [Mapping an organization](https://ecrou-exact.github.io/project-graph/docs/guide.html#mapping-an-organization): the procedure to follow, with a checklist and a prompt template
- [Document format](https://ecrou-exact.github.io/project-graph/docs/guide.html#document-format): every field of nodes, edges, types, tags and meta, with defaults and validation rules
- [Open Contributions Descriptor](https://ecrou-exact.github.io/project-graph/docs/guide.html#open-contributions-descriptor): how an OCD file becomes a map
- [Embedding](https://ecrou-exact.github.io/project-graph/docs/guide.html#embedding): iframe parameters and postMessage protocol
- [Hugo](https://ecrou-exact.github.io/project-graph/docs/guide.html#hugo): add a graph to any Hugo site. Hugo builds the JSON from the pages (front matter "graph" and "relations") or a data file, draws it as SVG without JavaScript, and shows the interactive graph with it. Includes a step-by-step procedure, a checklist and a prompt for AI agents
- [Reports](https://ecrou-exact.github.io/project-graph/docs/guide.html#reports): exports, and the protocol that writes any graph as English text

## Data

- [JSON schema](https://ecrou-exact.github.io/project-graph/docs/pivograph.schema.json): the document format for validators
- [Example: projects linked to Rulezet](https://ecrou-exact.github.io/project-graph/docs/examples/rulezet.json): a complete, checked map
- [Example: CIRCL GitHub organisations](https://ecrou-exact.github.io/project-graph/docs/examples/circl.json): an organisation in the centre, 21 organisations around it, logos and GitHub facts
- [Example: minimal map](https://ecrou-exact.github.io/project-graph/docs/examples/minimal.json)

## Optional

- [Source code](https://github.com/ecrou-exact/project-graph): MIT
- [App](https://ecrou-exact.github.io/project-graph/): load a map, edit it, export it