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, Tooling] CI ensures params docs are up-to-date #977

Open
5 tasks
bryanchriswhite opened this issue Dec 2, 2024 · 0 comments
Open
5 tasks

[Docs, Tooling] CI ensures params docs are up-to-date #977

bryanchriswhite opened this issue Dec 2, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation tooling Tooling - CLI, scripts, helpers, off-chain, etc...

Comments

@bryanchriswhite
Copy link
Contributor

Objective

Add a CI job which:

  1. Runs make docs_update_gov_params_page.
  2. If the git worktree is clean, pass; otherwise, fail.

Origin Document

image

See: #942 (comment)

Goals

  • Prevent potential confusion caused by inconsistencies between what's in version control and what is deployed to the docs site.

Deliverables

  • A PR which adds the CI job.

Non-goals / Non-deliverables

  • Automating updating the docs in version control in CI.

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @bryanchriswhite
Co-Owners: @Olshansk

@bryanchriswhite bryanchriswhite added documentation Improvements or additions to documentation tooling Tooling - CLI, scripts, helpers, off-chain, etc... labels Dec 2, 2024
@bryanchriswhite bryanchriswhite self-assigned this Dec 2, 2024
@Olshansk Olshansk moved this to 📋 Backlog in Shannon Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation tooling Tooling - CLI, scripts, helpers, off-chain, etc...
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant