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.

Sign up for GitHub

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

Jump to bottom

docs: split and cleanup README #182

Merged
merged 1 commit into from
Nov 21, 2023
Merged

docs: split and cleanup README #182

merged 1 commit into from
Nov 21, 2023

Conversation

lidel
Copy link
Member

@lidel lidel commented Nov 20, 2023

This PR aims to improve UX/DX

@lidel
docs: split and cleanup README
e4afb9b 
- add missing license info
- provisional logo
- split README into multiple docs
- add Usage and About sections to the README
@github-actions GitHub Actions
Copy link
Contributor

Results against Kubo latest:
(check the action's summary for the full results)

Summary

Tests Failures Errors Skipped
2046 0 0 0

@github-actions GitHub Actions
Copy link
Contributor

Results against Kubo master:
(check the action's summary for the full results)

Summary

Tests Failures Errors Skipped
2046 0 0 0

lidel
lidel commented Nov 20, 2023
View reviewed changes
README.md
Copy link
Member Author

Choose a reason for hiding this comment

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

ℹ️ the README got very long and this is my attempt at making it more friendly by focusing on "WHAT" it is and "WHY" it exists, and "HOW" being delegated to separate docs

docs/web-dashboard.md
Comment on lines +49 to +51
To add a new implementation to the dashboard:

- Ensure that implementation has significant user base and passes conformance tests.
Copy link
Member Author

Choose a reason for hiding this comment

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

ℹ️ @laurentsenta I've added this first point to ensure we only add "significant" implementations that pass tests. It is very vague on purpose – once we have a real world example of a third-party implementation that wants to be featured, we will adjust the language then.

I suspect nobody will want to implement the entire thing, and we will end up in projects that only show up for trustless-gateway etc.

@lidel lidel requested a review from hacdias November 20, 2023 21:20
@lidel lidel marked this pull request as ready for review November 20, 2023 21:20
laurentsenta
laurentsenta approved these changes Nov 21, 2023
View reviewed changes
Copy link
Contributor

@laurentsenta laurentsenta left a comment

Choose a reason for hiding this comment

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

Looks perfect, thanks for taking the time to clear that up and making a new logo :)

hacdias
hacdias approved these changes Nov 21, 2023
View reviewed changes
Copy link
Member

@hacdias hacdias left a comment

Choose a reason for hiding this comment

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

Quite amazing!

@lidel lidel merged commit de6b301 into main Nov 21, 2023
13 checks passed
@lidel lidel deleted the docs/split-readme branch November 21, 2023 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@laurentsenta laurentsenta laurentsenta approved these changes

@hacdias hacdias hacdias approved these changes

@2color 2color Awaiting requested review from 2color

Assignees
No one assigned
Labels
None yet
Projects
No open projects
IPFS Shipyard Team
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lidel @laurentsenta @hacdias