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

Update docs to be compatible with the documentation site #144

Closed
cam-schultz opened this issue Nov 17, 2023 · 1 comment
Closed

Update docs to be compatible with the documentation site #144

cam-schultz opened this issue Nov 17, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cam-schultz
Copy link
Contributor

Context and scope
The docs website (https://docs.avax.network/) converts markdown into a beautified website. In order to do this, we need to make the following changes to https://github.com/ava-labs/teleporter/blob/main/contracts/src/Teleporter/README.md and https://github.com/ava-labs/teleporter/tree/main/contracts/src/CrossChainApplications#getting-started-with-an-example-application

  • Put all documentation intended for the site in standalone markdown files (for example, separate the Getting Started section into its own file)
  • Convert all relative paths in links to absolute paths
  • Close all html tags
@cam-schultz cam-schultz added enhancement New feature or request documentation Improvements or additions to documentation labels Nov 17, 2023
@michaelkaplan13
Copy link
Collaborator

Closing as completed thanks to the ongoing DevRel effort to keep the docs up to date 🙏

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 enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

2 participants