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

Refactor docs #91

Merged
merged 8 commits into from
May 9, 2022
Merged

Refactor docs #91

merged 8 commits into from
May 9, 2022

Conversation

tavianator
Copy link
Owner

@tavianator tavianator commented Apr 19, 2022

This is an alternative to #90, taking some but not all of its changes. Here is the preview.

I kept most of the (collapsed) README content as I think it's helpful on the front page. I do think some of those sections could be shorter, with a link to a separate document for all the details. Here's my rough TODO list:

  • Move the "bfs adds some options that make common tasks easier" section to docs/Usage.md, just keeping a short summary in the README
  • Split docs/CONTRIBUTING.md into docs/Building.md and docs/Hacking.md

@tavianator
Copy link
Owner Author

@ElectronicsArchiver @data-man What do you think about this approach?

@codecov

This comment was marked as off-topic.

@ElectronicsArchiver
Copy link
Contributor

I can't say I prefer this..

@data-man
Copy link
Contributor

I kept most of the (collapsed) README content as I think it's helpful on the front page.

Yes. And a small amount of browser redirects.

@tavianator tavianator force-pushed the refactor-docs branch 2 times, most recently from 8584506 to 843e338 Compare May 7, 2022 15:50
@tavianator tavianator force-pushed the refactor-docs branch 2 times, most recently from 2083ac9 to 6041139 Compare May 7, 2022 18:04
@tavianator tavianator marked this pull request as ready for review May 7, 2022 18:06
@tavianator tavianator merged commit b078d8d into main May 9, 2022
@tavianator tavianator deleted the refactor-docs branch May 10, 2022 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants