kilt-node icon indicating copy to clipboard operation
kilt-node copied to clipboard

docs: Bring docs changes into DIP read me files

Open ChrisChinchilla opened this issue 1 year ago • 7 comments

fixes KILTProtocol/ticket#2976

Docs: Tweaks some grammar and readability to the DIP pallet readmes so they can be included in docs.

ChrisChinchilla avatar Feb 15 '24 15:02 ChrisChinchilla

Also please update the PR title to follow conventional commits (the CI fails due to that): https://www.conventionalcommits.org/en/v1.0.0/. This is probably a docs: PR.

ntn-x2 avatar Feb 16 '24 07:02 ntn-x2

@ntn-x2 At the moment, the plugin, which I have added here https://github.com/KILTprotocol/docs/pull/291 just pulls a raw file, but I think I can change the URL to be branches or tags instead. However, we need to setup versioning in the docs too to support this, which is tracked in https://github.com/KILTprotocol/ticket/issues/3149 so for now it will have to just be "develop", but that can change… soon ™️ . Short term not ideal, but I think we can track it manually until then.

ChrisChinchilla avatar Feb 16 '24 08:02 ChrisChinchilla

Mhhh then I'd rather have the docs point to the release branch than to develop. I'm saying this because there'll soon be few PRs which make the docs outdated.

ntn-x2 avatar Feb 16 '24 09:02 ntn-x2

@ntn-x2 Release 1.12.1?

ChrisChinchilla avatar Feb 16 '24 11:02 ChrisChinchilla

Correct.

ntn-x2 avatar Feb 16 '24 12:02 ntn-x2

@ntn-x2 OK, done! I'll now fix up the other end.

ChrisChinchilla avatar Feb 16 '24 15:02 ChrisChinchilla

@Ad96el @weichweich do you think we can merge this commit on the release branch and then cherry-pick it on develop? I am not sure if the changed README changes the metadata of the WASM, since it's used as the crate top-level documentation as well.

ntn-x2 avatar Feb 19 '24 08:02 ntn-x2

@ChrisChinchilla can you check if anything needs to be updated, and then we can merge this?

ntn-x2 avatar Apr 17 '24 13:04 ntn-x2

@ntn-x2 Oh! i thought it already was! Nothing has changed that affects this PR, no.

ChrisChinchilla avatar Apr 17 '24 14:04 ChrisChinchilla