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

docs(parachain): design for bitfield distribution #4346

Merged

Conversation

haikoschol
Copy link
Contributor

Changes

Add the design document for the bitfield distribution subsystem.

Issues

#4232

@haikoschol haikoschol changed the base branch from development to feat/parachain November 26, 2024 13:43
@haikoschol haikoschol changed the title haiko/feat/parachain/bitfield-distribution-design docs(parachain): design for bitfield distribution Nov 26, 2024
@haikoschol
Copy link
Contributor Author

Kept as draft until we decide where under docs we want to put design docs.

@P1sar
Copy link
Member

P1sar commented Nov 26, 2024

can you please put this in to design-proposals folder?

@haikoschol haikoschol force-pushed the haiko/feat/parachain/bitfield-distribution-design branch 2 times, most recently from ed9dd6c to ef96dcb Compare November 27, 2024 11:05
@haikoschol
Copy link
Contributor Author

can you please put this in to design-proposals folder?

According to the meeting notes, we decided on /docs/docs/design/parachain_protocol. Because it is already used in the docs folder (and because it looks better :) I've used kebab-case and put it in /docs/docs/design/parachain-protocol.

@haikoschol haikoschol force-pushed the haiko/feat/parachain/bitfield-distribution-design branch from ef96dcb to c9854f3 Compare November 27, 2024 11:10
@haikoschol haikoschol marked this pull request as ready for review November 27, 2024 11:10
Copy link
Contributor

@kishansagathiya kishansagathiya left a comment

Choose a reason for hiding this comment

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

You would want to put a link to this doc in the navigation bar. you would need to modify mkdocs.yml for that.

Copy link
Contributor

@timwu20 timwu20 left a comment

Choose a reason for hiding this comment

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

LGTM! Great work @haikoschol 👍

@P1sar P1sar added the S-doc documentation related. label Dec 2, 2024
@haikoschol haikoschol force-pushed the haiko/feat/parachain/bitfield-distribution-design branch from 29ca596 to be27e69 Compare December 3, 2024 11:40
@haikoschol haikoschol changed the base branch from feat/parachain to development December 3, 2024 11:40
@haikoschol
Copy link
Contributor Author

I've changed the branch this is based off from feat/parachain to development.

As discussed on #4349, we decided to add design documents to development to have them show up on https://gossamer.chainsafe.io/. The name of the feature branch is misleading now, but I figured it's the lesser evil over opening a new PR instead.

@edwardmack If you want to do the same on #4353, this is what I did:

  1. checked out my feature branch locally
  2. copied bitfield-distribution.md somewhere outside the repo
  3. checked out development
  4. renamed my feature branch (git branch -m haiko/feat/parachain/bitfield-distribution-design haiko/feat/parachain/bak-bitfield-distribution-design)
  5. created a new feature branch with the previous name
  6. copied bitfield-distribution.md to docs/docs/design and committed the added file
  7. edited availability-subsystems.md to link to bitfield-distribution.md and committed the change
  8. force pushed the new feature branch to github

@haikoschol haikoschol force-pushed the haiko/feat/parachain/bitfield-distribution-design branch from dd7d44b to c1055a6 Compare December 4, 2024 07:13
@haikoschol haikoschol merged commit a46ad52 into development Dec 4, 2024
24 checks passed
@haikoschol haikoschol deleted the haiko/feat/parachain/bitfield-distribution-design branch December 4, 2024 07:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-doc documentation related.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants