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

Add more content to main landing page #37

Merged
merged 2 commits into from
Sep 26, 2024

Conversation

bourque
Copy link
Member

@bourque bourque commented Sep 25, 2024

This PR moves the Purpose, Motivation, and Scope sections from the README.md to the main landing page of the RtD website (i.e. index.rst). In my opinion, it makes sense to keep the repository README to contain the bare-bones infomation that someone needs to contribute to the repo, while the RtD page should describe what the guidelines are all about. But this is just my opinion, I would like to hear what you think @vmartinez-cu and @kjbrooks!

@bourque bourque self-assigned this Sep 25, 2024
Copy link
Collaborator

@vmartinez-cu vmartinez-cu left a comment

Choose a reason for hiding this comment

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

Looks great! I like that you link to the read-the-docs in the README so that people can easily find an overview of the project. The added content to the read-the-docs main landing page gives it a more polished look. Nice job!

Copy link
Member

@kjbrooks kjbrooks left a comment

Choose a reason for hiding this comment

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

This all looks good to me and makes more sense!

@bourque bourque merged commit c724c1d into lasp:main Sep 26, 2024
8 checks passed
@bourque bourque deleted the add-content-to-main-page branch September 26, 2024 14:58
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