Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split contracts API doc into multiple files #640

Merged
merged 1 commit into from
Jun 29, 2023

Commits on Jun 28, 2023

  1. Split contracts API doc into multiple files

    Having all the contracts documented in one common file turned out to be hard to
    render by the GitBook. We're switching to documenting each contract file in a
    separate Markdown file.
    As the generated files will be much smaller now and GitBook has its own file `ON
    THIS PAGE` section, we don't need to generate Table of Contents.
    The one thing that we also change as part of this PR is `rsyncDelete` setting -
    we'll have it set to `true`, in order to delete documentation of contracts which
    get removed from the repo. As we're not working directly on a `main` branch,
    this isn't dangerous (we'll see all the delitions in the PR diff).
    michalinacienciala committed Jun 28, 2023
    Configuration menu
    Copy the full SHA
    8682e64 View commit details
    Browse the repository at this point in the history