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

docs: update docs & benchmarks related docs #1553

Merged
merged 2 commits into from
Nov 20, 2024
Merged

docs: update docs & benchmarks related docs #1553

merged 2 commits into from
Nov 20, 2024

Conversation

Imod7
Copy link
Contributor

@Imod7 Imod7 commented Nov 20, 2024

Description

Updated the docs to reflect the recent changes in Sidecar documentation & benchmarks.

This is a result from the changes in Sidecar workflows done by the CI Team. Related PRs:

Important Note for Contributors & Maintainers

  • When you update the documentation in a PR, it is no longer needed to build the docs (with yarn build:docs). You only need to update and commit the src/openapi-v1.yaml file. The docs will be built & published automatically in gh-pages as soon as the PR is merged in master branch.
  • Benchmarks are now published in Github pages as well under the URL https://paritytech.github.io/substrate-api-sidecar/dev/bench/. Data will be updated with every commit in master branch. Currently there is only one data point from the last commit.

@Imod7 Imod7 requested a review from a team as a code owner November 20, 2024 13:06
Copy link
Contributor

@IkerAlus IkerAlus left a comment

Choose a reason for hiding this comment

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

LGTM

@Imod7 Imod7 merged commit bd9cad8 into master Nov 20, 2024
14 of 15 checks passed
@Imod7 Imod7 deleted the domi-update-docs branch November 20, 2024 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants