Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Add separate how bitswap works doc #294

Merged
merged 2 commits into from
Apr 7, 2020
Merged

Add separate how bitswap works doc #294

merged 2 commits into from
Apr 7, 2020

Conversation

dirkmc
Copy link
Contributor

@dirkmc dirkmc commented Mar 12, 2020

No description provided.

Copy link
Member

@daviddias daviddias left a comment

Choose a reason for hiding this comment

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

@dirkmc this is great. Can you add some architecture diagrams like https://github.com/ipfs/js-ipfs-bitswap#structure ?

@dirkmc
Copy link
Contributor Author

dirkmc commented Apr 3, 2020

I'm a little wary of adding an architecture diagram, as they tend to quickly become out of date as the code is refactored. My preference is to have really good documentation in the code itself.

How do you feel about the pros / cons @daviddias ?

@Stebalien
Copy link
Member

I'd like to add a general architecture diagram, but for different reasons. Making an architecture diagram will let us plan the next refactor. That is:

  1. Diagram the current architecture.
  2. Play with it to create the architecture we want.
  3. Refactor.
  4. Diagram the result.

@dirkmc
Copy link
Contributor Author

dirkmc commented Apr 3, 2020

Ok fair enough I'll do that

@dirkmc
Copy link
Contributor Author

dirkmc commented Apr 6, 2020

I updated the existing architecture diagram and added an Implementation section. Let me know if that's enough detail, otherwise I can add some more

docs/how-bitswap-works.md Show resolved Hide resolved
docs/go-bitswap.puml Show resolved Hide resolved
@dirkmc
Copy link
Contributor Author

dirkmc commented Apr 7, 2020

I'm going to merge this in as it's been open for a while and seems to be in a good state. We can make further documentation improvements in new PRs.

@dirkmc dirkmc merged commit b0f337d into master Apr 7, 2020
@dirkmc dirkmc deleted the docs/how-bitswap-works branch April 7, 2020 20:46
@dirkmc dirkmc mentioned this pull request Apr 7, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants