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

PK-Docs 1.0: Revamping tutorials/Getting Started Documentation #92

Closed
wants to merge 8 commits into from

Conversation

CryptoTotalWar
Copy link
Contributor

@CryptoTotalWar CryptoTotalWar commented Jul 7, 2024

Description

Issues Fixed

Tasks

  • 1. add sidebar for docs homepage

  • 2. edit docs homepage for engagement and effective overview of the docs

    • clean up to the point that its a sufficient overview for a V0
  • 3. flesh out / update a finalized version of the polykey-set-up page for installing and bootstrapping

  • 4. flesh out / update a finalized version for connecting to an IDP

  • 5. flesh out / finalize a PK demo that follows the demo tutorial but requires bootstrapping / managing a second node locally, alternatively, they can find another dev to perform the demo with... Ideal.

  • 6. clean up getting-started docs, the previous documentation should be synthesized in reference guide documentation

Final checklist

  • Domain specific tests
  • Full tests
  • Updated inline-comment documentation
  • Lint fixed
  • Squash and rebased
  • Sanity check the final build

@CryptoTotalWar CryptoTotalWar self-assigned this Jul 7, 2024
@CryptoTotalWar
Copy link
Contributor Author

Duplicate. This one had a period in the feature branch that was also causing problems.

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
Development

Successfully merging this pull request may close these issues.

Polykey-Docs 1.0: Revamping the PK-CLI set-up Guide under Getting Started Category
2 participants