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

Generic documentation #98

Merged
merged 8 commits into from
Jan 16, 2024
Merged

Generic documentation #98

merged 8 commits into from
Jan 16, 2024

Conversation

ozgunozerk
Copy link
Collaborator

Fixes #61

There are some modifications that I've made. I'm going to explain them below. If you disagree with them, feel free to comment, or we can discuss them on a meeting.

For the runtime template doc:

  • I removed config description for each pallet
    • it would make the runtime doc too long
    • the configs for important pallets are already explained in their respective docs
    • I know that the reason to include config in runtime docs is to explain what is special about its config. However, explaining the config for each pallet is an overkill imo.
    • so, I put another section for *important config changes specific to this runtime`
  • for generic runtime documentation, comparing it with other templates does not serve any purpose imo
  • moved pallet proxy from system to governance, to make it consistent with multisig and sudo. If you think they should all be in system, that is also acceptable.

@ozgunozerk ozgunozerk added the documentation Improvements or additions to documentation label Jan 9, 2024
@ozgunozerk ozgunozerk requested review from KitHat and 4meta5 January 9, 2024 12:21
@ozgunozerk ozgunozerk self-assigned this Jan 9, 2024
Copy link

netlify bot commented Jan 9, 2024

Deploy Preview for docs-oz-polkadot canceled.

Name Link
🔨 Latest commit 37c3128
🔍 Latest deploy log https://app.netlify.com/sites/docs-oz-polkadot/deploys/65a6503ae09f250008a585b0

runtime/src/lib.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@4meta5 4meta5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally this PRs scope would be limited to the documentation and any code changes would be independently proposed in a separate PR.

@ozgunozerk
Copy link
Collaborator Author

ozgunozerk commented Jan 9, 2024

Ideally this PRs scope would be limited to the documentation and any code changes would be independently proposed in a separate PR.

Yeah I thought about that, was indecisive for this one. Will separate it and submit another PR for it 👍

Edit: done!

@ozgunozerk ozgunozerk requested a review from 4meta5 January 10, 2024 08:19
Copy link
Member

@KitHat KitHat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, could you please add the generic.adoc to navigation?

docs/templates/runtime.adoc Show resolved Hide resolved
docs/templates/runtime.adoc Outdated Show resolved Hide resolved
@ozgunozerk
Copy link
Collaborator Author

ozgunozerk commented Jan 12, 2024

I wanted to make it more aesthetic by using contract items and subheadings, however, I couldn't apply those inside collapsible. If you know a better way, let me know

@ozgunozerk ozgunozerk requested a review from KitHat January 12, 2024 11:22
@ozgunozerk ozgunozerk enabled auto-merge (squash) January 16, 2024 09:45
@ozgunozerk ozgunozerk merged commit db59c2f into main Jan 16, 2024
4 checks passed
@ozgunozerk ozgunozerk deleted the generic-documentation branch January 16, 2024 12:54
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
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

🎁 [Feature Request]: Create a documentation for the Generic Runtime Template
3 participants