Polar path documentation

[ChrisChinchilla]

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

[ChrisChinchilla]

@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?

[aws-amplify-eu-central-1]

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

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

[ntn-x2]

@ChrisChinchilla what's the status of this PR?

[ChrisChinchilla]

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

[ChrisChinchilla]

@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]

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

[ntn-x2]

@ChrisChinchilla can you look into the CI status please? Thank you.

[ChrisChinchilla]

@ntn-x2 I'll check, but a lot of the tests are getting replaced due to the SDK changes in other PRs anyway, so I'll check why it's not building, but it may not be worth fixing the code examples in this PR.

[ChrisChinchilla]

@ntn-x2 The latest push fixes the paths if I take the file from develop; if you think it needs to be from the release branch, I need to think a bit more; in those branches, the link is incorrect.

[ntn-x2]

@ChrisChinchilla the fixes will anyway be included in the next release, so please just make a ticket reminding us to replace develop with the next release branch, and provide a brief explanation as a context for the ticket. Then, we can go ahead and merge this targeting develop at the moment.

[ChrisChinchilla]

@ntn-x2 Here you go: https://github.com/KILTprotocol/ticket/issues/3645