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

Added FAQ and README updates #260

Merged
merged 2 commits into from
Apr 12, 2023
Merged

Added FAQ and README updates #260

merged 2 commits into from
Apr 12, 2023

Conversation

BigLep
Copy link
Contributor

@BigLep BigLep commented Apr 5, 2023

Getting the FAQ into a more durable location: #190

This also involved pulling in various parts from ipfs/kubo#8543 so it can get resolved.

Various slack conversations like #boxo-maintainers thread https://filecoinproject.slack.com/archives/C04M8232QRW/p1677103751480109 were also reviewed.

Some new concepts were added in here like our deprecation policy.

@BigLep BigLep requested a review from guseggert April 5, 2023 09:10
@BigLep BigLep self-assigned this Apr 5, 2023
@BigLep BigLep requested a review from a team as a code owner April 5, 2023 09:10
Copy link
Contributor Author

@BigLep BigLep left a comment

Choose a reason for hiding this comment

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

@guseggert : feel free to take over and edit at will. I wanted to get us over the hump of not having some of this info in a more durable location that we couldn't PR.

@codecov
Copy link

codecov bot commented Apr 5, 2023

Codecov Report

Merging #260 (2633f3e) into main (c5fba8c) will increase coverage by 0.31%.
The diff coverage is n/a.

❗ Current head 2633f3e differs from pull request most recent head c1a5d0c. Consider uploading reports for the commit c1a5d0c to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #260      +/-   ##
==========================================
+ Coverage   47.88%   48.20%   +0.31%     
==========================================
  Files         273      273              
  Lines       33186    33388     +202     
==========================================
+ Hits        15892    16095     +203     
- Misses      15617    15623       +6     
+ Partials     1677     1670       -7     

see 22 files with indirect coverage changes

@BigLep BigLep mentioned this pull request Apr 6, 2023
docs/FAQ.md Outdated Show resolved Hide resolved
@BigLep
Copy link
Contributor Author

BigLep commented Apr 12, 2023

@guseggert : ready for re-review. I moved the content into wiki pages: https://github.com/ipfs/boxo/wiki

The README refavtor is still there.

I think it likely makes sense to move more of the README to wiki as well so we have a central place for our docs.

@guseggert guseggert force-pushed the docs/faq-2023-04-04 branch 4 times, most recently from 176ef5e to 0e078c4 Compare April 12, 2023 14:48
@guseggert guseggert merged commit b3b6620 into main Apr 12, 2023
@guseggert guseggert deleted the docs/faq-2023-04-04 branch April 12, 2023 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants