avalanchego icon indicating copy to clipboard operation
avalanchego copied to clipboard

P-chain - Technical docs update

Open abi87 opened this issue 1 year ago • 3 comments

Why this should be merged

We have some technical documentation stored in platformvm package, which was not visible enough, nor updated. This PR start to tackle these issues.

How this works

Refreshed existing doc, drop outdated one and added a README at platformvm package level for visibility.

How this was tested

a human reading the doc

abi87 avatar Feb 26 '24 17:02 abi87

Thanks for putting this up!

I wonder what the best way to document the various transaction types on the P-Chain is. It seems like this is the last section that is still distributed throughout the rest of the docs making it a bit harder to follow. Do you think it makes sense to add one more doc enumerating each of the transaction types?

We do have the list in our officlal docs. I have mentioned the link in the doc

abi87 avatar Feb 28 '24 08:02 abi87

@abi87 I plan on migrating all the api.md docs directly to the Avalanchego repo, and pulling into the docs, similar to how the this page is pulled directly from the AWM Relayer repo.

for example, i would move https://github.com/ava-labs/avalanche-docs/blob/master/docs/reference/avalanchego/p-chain/api.md to https://github.com/ava-labs/avalanchego/tree/master/vms/platformvm/ , and rename the file service.md (per @StephenButtolph 's request).

should we do the same for the transaction format file?

meaghanfitzgerald avatar Mar 07 '24 16:03 meaghanfitzgerald

This PR has become stale because it has been open for 30 days with no activity. Adding the lifecycle/frozen label will cause this PR to ignore lifecycle events.

github-actions[bot] avatar Apr 14 '24 00:04 github-actions[bot]