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

Automatic documentation #915

Merged
merged 9 commits into from
Nov 19, 2024

Conversation

tombeynon
Copy link
Collaborator

@tombeynon tombeynon commented Nov 18, 2024

Adds a document.sh script which can be run with arguments (./document.sh akash cosmoshub) or without (./document.sh) to run for all chains. It will create the relevant deploy.yml, docker-compose.yml and README.md files dynamically based on the build.yml configuration file. Polkachu configuration is applied dynamically depending on support indicated by their API.

This ensures all chain specific documentation are kept standardised and up-to-date. Note that the script has not been run yet, but will be run once all open PRs have been merged as many are pending right now and will impact the resulting documentation (notably #912).

This PR also updates the build.yml configurations to remove unnecessary config and only provide 'recommended' environment variables which are included in the documentation.

Finally it renames seinetwork to sei and removes a few chains that are either dead, or not supported by Chain Registry. These are:

  • autonomy
  • defund
  • dig
  • elysnetwork
  • vidulum

@tombeynon tombeynon merged commit 643e11c into akash-network:master Nov 19, 2024
1 check passed
@tombeynon tombeynon deleted the automatic-documentation branch November 19, 2024 18:37
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.

1 participant