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

Polar path documentation #319

Open
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

ChrisChinchilla
Copy link
Contributor

@ChrisChinchilla ChrisChinchilla commented Jul 9, 2024

fixes KILTProtocol/ticket#3472

Adds Polar path documentation

  • Step 1
  • Step 2
  • etc.

Checklist:

  • I have verified that the code works
  • I have verified that the code is easy to understand
    • If not, I have left a well-balanced amount of inline comments
  • I have left the code in a better state
  • I have documented the changes (where applicable)
    • Either PR or Ticket to update the Docs
    • Link the PR/Ticket here

Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
@ChrisChinchilla
Copy link
Contributor Author

@ntn-x2 Pretty rough draft and I want to get your input on a few things in particular, but for the general structure, what are initial thoughts?

Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-319.d3oeht7cvddn19.amplifyapp.com

Signed-off-by: Chris Chinchilla <[email protected]>
docs/develop/09_polarpath/01_overview.md Outdated Show resolved Hide resolved
docs/develop/09_polarpath/01_overview.md Outdated Show resolved Hide resolved
docs/develop/09_polarpath/01_overview.md Outdated Show resolved Hide resolved
docs/develop/09_polarpath/01_overview.md Outdated Show resolved Hide resolved
docs/develop/09_polarpath/01_overview.md Outdated Show resolved Hide resolved
docs/develop/09_polarpath/01_overview.md Outdated Show resolved Hide resolved
docs/develop/09_polarpath/01_overview.md Outdated Show resolved Hide resolved
Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
@ntn-x2
Copy link
Member

ntn-x2 commented Aug 5, 2024

@ChrisChinchilla what's the status of this PR?

Signed-off-by: Chris Chinchilla <[email protected]>
@ChrisChinchilla
Copy link
Contributor Author

Build will currently fail as the path doesn't exist yet.

Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
Signed-off-by: Chris Chinchilla <[email protected]>
@ChrisChinchilla
Copy link
Contributor Author

@ntn-x2 Ready again, and we also have the node autogenerated docs if needed, but it looks like the comments generally refer people to the read me / docs anyway.

@ntn-x2
Copy link
Member

ntn-x2 commented Aug 29, 2024

Hey, build is failing. Otherwise changes look ok to me.

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.

2 participants