This repository has been archived by the owner on Oct 11, 2024. It is now read-only.
docs: Consolidate TS client Markdown docs into single file #334
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fabioberger
changed the title
…d modify the `docs:md` command to do it
fabioberger
force-pushed
the
docs/consolidateTSClientMd
branch
from
acba21a to
d6bacae
Compare
4 tasks
albrow
approved these changes
Aug 5, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, every class, interface and enum definition was in a separate file. This made it harder to navigate the docs. This PR put's them all into a single file. This is work that will be useful for the next 0x docs re-design too.
Additionally, it also uploads a copy of the docs for the specific version being published to S3. The 0x website will pull these down and also render Mesh TS client docs and have them be searchable from the website's search bar.