mirror of
https://github.com/google/flatbuffers.git
synced 2026-06-02 04:04:19 +00:00
60463e25a8
There is a typo in the schema.md file in documentation. An empty 'required' section was added right before the 'required' item in the middle of the attributes list. It even appears in the table of content, which might confuse readers, making it look like following attributes might be required while they are not. You can notice the issue there: https://flatbuffers.dev/schema/#attributes. I did check that `mkdocs serve -f mkdocs.yml` does produce the expected output (the same attributes list without that extra empty `required` section in the middle) with my changes.
Documentation
This is the source of the FlatBuffers documentation, that is served at https://flatbuffers.dev.
Local Building
The documentation can be built and served locally during development, see https://flatbuffers.dev/contributing/#local-development for full details.
tl;dr
Install:
pip install mkdocs-material
pip install mkdocs-redirects
Build and Serve:
mkdocs serve -f docs/mkdocs.yml