documentation
documentation copied to clipboard
WIP Polishes docs
This is a general update to docs:
- [x] Removes the clis for
python-clientandscala-clientfrom the docs. We removed them from the corresponding packages because they supported different sets of options, Scala one had been broken for several versions, and we agreed the only cli to be used within a terminal should be the Go one. - [x] Review getting started section to update
bblfshdto newly added rootless containers. - [x] Fixes link to join community (broken).
- [x] Links template for design doc (the process for proposing new features was outdated with BIPs and we did not described a way of pitching in with design tasks). I made that link public in our GDrive, since it does not contain sensible information and it is just a template.
- [ ] Writes a CONTRIBUTE section with frequently asked questions:
- [ ] If I develop my own driver, how do I test it with
bblfshd? - [ ] If I want to fix a failure in
libuastthat propagates toscala-clientandpython-client, how do I do it? - [ ] How do I fix a failure in
sdkand update it locally to test a*-driver? - [ ] How do I modify and test
bblfshdlocally?
- [ ] If I develop my own driver, how do I test it with
- [x] Renames Babelfish web client to Babelfish playground in the index, since that terminology has been used before in the docs, and web client can be misleading with respect to
bblfsh-clientsfor new users. - [ ] Adds
AnyOrderto the list of supported orders by the clients. - [x] Updates
tree-sitterdescription, which does not reflect the actual state of that project. - [x] Updates the table of
clientsto reflect current state of things. - [ ] Dumps in the docs the content of the post in our forum about differences between ASTs, UASTs, and annotated ASTs.
Note: CI integration failing because we have to wait for https://github.com/bblfsh/bblfshd/pull/318 to be merged