Skip to content

[skip changelog] Revamp the README #603

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
Merged
merged 8 commits into from
Mar 5, 2020
Merged

[skip changelog] Revamp the README #603

merged 8 commits into from
Mar 5, 2020

Conversation

masci
Copy link
Contributor

@masci masci commented Mar 5, 2020 •
edited
Loading

Now that we have a documentation hub, let's keep the README small and effective. In this PR:

  • Moved docs out of the README into dedicated pages in the docs
  • Restored markdown format for the README: we moved temporarily to rst because we needed atomatic TOC
  • Added a dedicated page for installation options
  • Created a FAQ page (almost empty but it'll grow soon)
  • Fixed the GitHub workflow to publish docs, it wasn't running on PR merges

@masci masci added the topic: documentation Related to documentation for the project label Mar 5, 2020
@masci masci requested a review from rsora March 5, 2020 09:41
rsora
rsora approved these changes Mar 5, 2020
View reviewed changes
Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

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

:shipit:

@per1234
Copy link
Contributor

per1234 commented Mar 5, 2020

The logo seems a bit larger than necessary to me.

@masci masci merged commit bdcfd89 into master Mar 5, 2020
@masci masci deleted the massi/docs branch March 5, 2020 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rsora rsora rsora approved these changes

Assignees
No one assigned
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@masci @per1234 @rsora