Trustfall Docs Tracking Issue #819
Description
As I've been doing some docs work recently with Predrag's blessing here's a tracking issue. This is written with the assumption #807 will be merged
Query Language
Language features, currently all have at least a page which is partially done, but only checked off ones are comprehensive enough for a first release. Other things needing doing will likely impact them though!
- filter
- fold
- optional
- output
- recurse
- tag
- transform (maybe okay for the initial one)
- type coercion
- Limitations and gotchas for features
Doc Features
- Trustfall playground links for example queries for anything discussed in the docs (better than the fake twitter example being mentioned again and again) - this will also require writing more example queries for the playground!
- playground links embeddable in the docs (like rustdoc example code going to rust playground)
- Accessibility/Internationalisation. mkdocs might cover an amount of this already? But worth thinking about/assessing
Rust Docs
- Using trustfall_stubgen
- Recommendations of project structure
- More user/usage guides than the trustfall library documentation
Questions/Thoughts
- Linking to external 3rd party content, conference talks, other things that might help guide people.
- If we think about the diataxis framework with: how-to-guides, tutorials, technical reference and explanations. Is there a limit on what we want to hit/cover. Obviously, the more that's documented the more that needs to be maintained. Currently, there's some light tutorial and technical reference but nothing on the deeper explanations or more general how-to-guides.