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

Concepts overhaul: consolidate basic concepts into 2 page overview, ideas and theory #1457

Merged
merged 44 commits into from
Mar 2, 2023

Conversation

ElPaisano
Copy link
Contributor

@ElPaisano ElPaisano commented Jan 26, 2023

Preview: https://bafybeihbdxf2bb2u6sjcuftcptotflolmg32kvtong2244ehigajxvbe3i.on.fleek.co/

Bonus:
Figured out how to add tooltips (you can try them on the draft). I think this generally makes introing these concepts easier

This PR overhauls the concepts section in a few ways:

  1. Consolidates "basic" IPFS concepts into two page, with content grouped as follows:

    • IPFS defined, what IPFS isn't, problems that IPFS addresses -> IPFS and the problems it solves
    • Addressing, routing and transferring of content addressed data, subsystems intro / benefits -> How IPFS works
  2. Rewrites and prunes the following so that they ONLY contain conceptual info, not "hands-on", practical stuff like code samples that should be elsewhere. Regroups these pages into new Concepts -> Ideas and Theory sidebar menu subsection:

  3. Takes pruned info from pages above and adds it Guides.

  4. Adds a header / blurb to conduct readers to the guides on the Concepts landing page

I tried to emphasize subsections of no more than a few paragraphs - really trying to give a super condensed introduction to the what and why of IPFS.

Todo list

  • Fill in headers with empty content (Lorem ipsum)
  • Copy review
  • Tech review

Describe your changes

Addresses #1433

Checklist before requesting a review

  • Passing the beta version of the Check Markdown links for modified files check. Action results can be viewed here.

Checklist before merging

  • Passing all required checks (The beta Check Markdown links for modified files check is not required)

@ElPaisano ElPaisano added this to the 1/20/27 - 2/3/22 milestone Jan 26, 2023
@ElPaisano ElPaisano linked an issue Jan 26, 2023 that may be closed by this pull request
2 tasks
@ElPaisano ElPaisano self-assigned this Jan 26, 2023
@ElPaisano ElPaisano added the need/maintainers-input Needs input from the current maintainer(s) label Jan 26, 2023
@ElPaisano
Copy link
Contributor Author

Headers:

  • Problems that IPFS addresses
  • Addressing, routing and transferring (see @2color defintion)

@ElPaisano
Copy link
Contributor Author

After writing more, I feel like 2 pages might be better... any thoughts?

Copy link
Member

@2color 2color left a comment

Choose a reason for hiding this comment

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

After writing more, I feel like 2 pages might be better... any thoughts?

  • What is IPFS?
  • How IPFS Works?

Yes

docs/concepts/ipfs-primer.md Outdated Show resolved Hide resolved
docs/concepts/ipfs-primer.md Outdated Show resolved Hide resolved
docs/concepts/ipfs-primer.md Outdated Show resolved Hide resolved
docs/concepts/ipfs-primer.md Outdated Show resolved Hide resolved
@ElPaisano
Copy link
Contributor Author

@walkerlj0 per our discussion, tagging you on this PR.

TLDR:
Attempts to consolidate "basic" IPFS concepts into 1-2 pages

@2color
Copy link
Member

2color commented Feb 7, 2023

I will get to the How IPFS Works this week

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/discussion need/maintainers-input Needs input from the current maintainer(s)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consolidate "Basic Concepts" into 1-2 page overview
2 participants