Start on new version of specification
documentationv2
This is the start of a new specification
Things I would like to improve on the existing specification
- Include more of the whole project (parser, etc)
- Split the current 5k file into smaller parts
- Add more information around certain topics
- A few more tests here and there for certain behavior
- Also act as documentation for the project
- Published on the web alongside the playground
Currently running the code blocks is done by a `build.rs` and some helper methods. I think it would be cool to build out a general testing tool based on markdown. However, that is something more for the future. Initially we can do something similar to before but not using `build.rs` and generating a bunch of Rust code.
Some first things to complete
- [ ] Merge existing "documentation"
- [ ] Merge existing tests
- [ ] Enumerate file names
- [ ] Think about layout more
- [ ] Move to respective crate directories and use symbolic links
Then
- [ ] More tests
- [ ] Lint and spell check markdown files
- [ ] Publishing to HTML
合并状态:未合并 1 条评论