5 Commits

Author SHA1 Message Date
50d4482dc6 docs: Update docs about how to build the docs (#1970)
* docs: Update docs about how to build the docs

* Change name on sphinx targets

* Add doc-live-build
2022-09-30 19:03:04 +00:00
de04514e29 ci: Markdown linting (#1920)
Adds markdown linting to the CI and fixes up all the current files.
2022-09-19 21:17:50 +00:00
999caca10f docs: Added Style Guide and Test Writing Guide (#1897)
The Style Guide moved into the Documentation site for better visibility. Removed lots of discussion around topics that are already enforced by the formatter/linter. Added new advice regarding a variety of topics.

The Test Writing Guide discusses how to write tests for Flame, and what kinds of tests are available.
2022-09-18 20:21:03 +00:00
58571141bc docs: Added ability to create infobox-style widgets in the documentation (#1771)
Additional mode "infobox" allows Flutter widgets to be inserted into the generated documentation site as wikipedia-style infoboxes floating on the right. This is useful for presenting content to the user up-front without sacrificing the flow of the exposition. For example, currently the Tap Events demo is "hidden" in the middle of a long page.

We believe that presenting the content in this way would make the user more excited to read about it.
2022-07-02 01:02:19 +02:00
ea354e3a81 docs: Documenting how to write documentation (#1721)
Since our documentation is fairly complex, we need to have a document which describes how various parts of it work. This PR adds such documentation.
2022-06-14 16:45:48 +02:00