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

add README.md to documentation #167

Closed
natestemen opened this issue Jan 13, 2025 · 1 comment · Fixed by #174
Closed

add README.md to documentation #167

natestemen opened this issue Jan 13, 2025 · 1 comment · Fixed by #174
Assignees
@jordandsullivan
Labels
documentation Improvements or additions to documentation

Comments

@natestemen
Copy link
Member

The readme is not currently in the built documentation. This can act as a nice landing page, but it needs to be converted to RST in order to be included in the documentation.
@natestemen natestemen added the documentation Improvements or additions to documentation label Jan 13, 2025
@jordandsullivan
Copy link
Collaborator

For now let's just copy it manually so that people have a landing page/intro for the RTD.

@jordandsullivan jordandsullivan self-assigned this Jan 16, 2025
@jordandsullivan jordandsullivan linked a pull request Jan 17, 2025 that will close this issue
167 add readmemd to documentation #174
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jordandsullivan jordandsullivan

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

167 add readmemd to documentation unitaryfund/ucc
2 participants
@natestemen @jordandsullivan