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

Populate repository README #52

Closed
5 tasks done
eb8680 opened this issue Oct 21, 2022 · 3 comments · Fixed by #170
Closed
5 tasks done

Populate repository README #52

eb8680 opened this issue Oct 21, 2022 · 3 comments · Fixed by #170
Assignees
@agrawalraj
Labels
documentation Improvements or additions to documentation
Milestone
Initial public re...

Comments

@eb8680
Copy link
Contributor

eb8680 commented Oct 21, 2022 •
edited by agrawalraj
Loading

Missing info:

  • Installation instructions
  • Quick library introduction
  • Code example(s)
  • Links to documentation
  • Buttons
@eb8680 eb8680 added the documentation Improvements or additions to documentation label Oct 21, 2022
@eb8680 eb8680 added this to the Initial public release milestone Oct 21, 2022
@eb8680 eb8680 assigned eb8680 and unassigned eb8680 Oct 21, 2022
@eb8680 eb8680 self-assigned this Nov 3, 2022
@eb8680
Copy link
Contributor Author

eb8680 commented Jan 3, 2023

This can just be a reformatted version of the content on the main documentation landing page.

@eb8680 eb8680 assigned agrawalraj and unassigned eb8680 Jul 3, 2023
@agrawalraj agrawalraj linked a pull request Jul 3, 2023 that will close this issue
Causal Pyro README #170
Merged
@agrawalraj agrawalraj mentioned this issue Jul 3, 2023
Merged
@azane
Copy link
Contributor

azane commented Jul 6, 2023

Since the documentation landing page and README are (or are nearly) equivalent, we could make the README an .rst file and then include its contents in the index.rst of the landing page. See here for example.

@azane
Copy link
Contributor

azane commented Jul 6, 2023

We could also include the README as a markdown file like so: https://stackoverflow.com/a/46012023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@agrawalraj agrawalraj

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Initial public release
Development

Successfully merging a pull request may close this issue.

Causal Pyro README BasisResearch/chirho
3 participants
@eb8680 @agrawalraj @azane