Skip to content
This repository has been archived by the owner on Mar 8, 2020. It is now read-only.

WIP Polishes docs #288

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

WIP Polishes docs #288

wants to merge 3 commits into from

Conversation

ncordon
Copy link
Member

@ncordon ncordon commented Oct 25, 2019

This is a general update to docs:

  • Removes the clis for python-client and scala-client from 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.
  • Review getting started section to update bblfshd to newly added rootless containers.
  • Fixes link to join community (broken).
  • 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 libuast that propagates to scala-client and python-client, how do I do it?
    • How do I fix a failure in sdk and update it locally to test a *-driver?
    • How do I modify and test bblfshd locally?
  • 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-clients for new users.
  • Adds AnyOrder to the list of supported orders by the clients.
  • Updates tree-sitter description, which does not reflect the actual state of that project.
  • Updates the table of clients to 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.

This change is Reviewable

@ncordon ncordon requested a review from a team as a code owner October 25, 2019 10:50
@ncordon
Copy link
Member Author

ncordon commented Oct 25, 2019

Note: CI integration failing because we have to wait for bblfsh/bblfshd#318 to be merged

Copy link
Contributor

@bzz bzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 7 of 7 files at r1.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants