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

Reduce README, moving more things to the book #1245

Closed
nyurik opened this issue Mar 11, 2024 · 0 comments · Fixed by #1253
Closed

Reduce README, moving more things to the book #1245

nyurik opened this issue Mar 11, 2024 · 0 comments · Fixed by #1253
Assignees
@sharkAndshark
Labels
docs help wanted

Comments

@nyurik
Copy link
Member

nyurik commented Mar 11, 2024

Currently the readme has far too much info, and some of it less or more descriptive than the book. We shouldn't maintain two copies of the same stuff - better move it to the book. For example, install section of the book has fewer details than the readme.
@sharkAndshark sharkAndshark self-assigned this Mar 14, 2024
@sharkAndshark sharkAndshark mentioned this issue Mar 15, 2024
Merged
6 tasks
nyurik added a commit that referenced this issue May 26, 2024
@sharkAndshark @nyurik
Adjust readme and martin book (#1253)
a9cb0c9 
Fixes #1245

Large book and README refactoring, adding quick started section, list of available features to the README, and moving most of the content from README to the book.

---------

Co-authored-by: Yuri Astrakhan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sharkAndshark sharkAndshark

Labels
docs help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adjust readme and martin book sharkAndshark/martin
2 participants
@nyurik @sharkAndshark