General overview

The SPiD technical documentation consists of:

• Guides: Hands-on technical articles with code examples that work.
• Working examples: Minimal, but complete examples that can be cloned and run.
• API reference: Details on all the offered endpoints in the API.

As well as article pages on different topics.

Building blocks

Data for the docs is pulled from several sources:

• The API itself: The routes-file (via the /endpoints endpoint) is used to build the comprehensive API endpoints list.
• The tech-docs repo: Contains additional information about endpoints, types and articles.
• The working examples: Snippets of code are extracted from the full examples, and used in the guides.

All this information is merged together and used as a basis for building the tech-docs site. See Data sources.

Documentation formats

1. Markdown is used for articles/guides and other textual descriptions. Many Github extensions are supported by the parser.

2. edn is used for structured meta-data and content that is cross-linked or otherwise used across multiple places in the documentation. edn is like JSON, but has native support for more data types.

Writing documentation

Check out the home page.