Documenting the Vega protocol

This repo includes documentation about the Vega protocol.

If you have any questions, drop them into Vega's Discord or Forum.

Software

This website is built using Docusaurus 2. For more information on how to make changes in this repository, or how to run the site locally, see CONTRIBUTING.md.

Docusaurus plugins

• docusaurus-protobuffet - Protobuf docs
• docusaurus-openapi-docs - REST docs
• docusaurus2-graphql-doc-generator - GraphQL docs
• docusaurus-search-local - Search

Versioning

All of the text content and API documentation is tied to a release version of the core. To understand how we used Docusaurus versioning, see VERSIONING.md.

Configuration notes

• GraphQL docs are generated in to /docs/graphql/
• docusaurus-protobuffet-plugin is used to generate docs, but unlike the defaults setup generates them into the /docs/ so as to avoid documenting them separately
• New versions of REST docs are configured in docusaurus.config.js
• When copying between versions, some files (particularly ones with Ethereum addresses) need to be checked to ensure the Frontmatter point to the right networks

License

MIT