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

167 add readmemd to documentation #174

Merged
merged 12 commits into from
Jan 18, 2025

Conversation

jordandsullivan
Copy link
Collaborator

Got this working!

@jordandsullivan jordandsullivan linked an issue Jan 17, 2025 that may be closed by this pull request
Copy link
Collaborator

@Misty-W Misty-W left a comment

Choose a reason for hiding this comment

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

Great that you got this working @jordandsullivan!

When I build the docs I get the following warnings:
/Users/mistywahl/Documents/GitHub/ucc/docs/source/../README.md.rst:3: WARNING: Document headings start at H2, not H1 [myst.header]
/Users/mistywahl/Documents/GitHub/ucc/docs/source/../README.md.rst:9: WARNING: Document headings start at H2, not H1 [myst.header]
/Users/mistywahl/Documents/GitHub/ucc/docs/source/../README.md.rst:21: WARNING: Document headings start at H2, not H1 [myst.header]

@Misty-W
Copy link
Collaborator

Misty-W commented Jan 18, 2025

Also I can't add a comment on the unmodified line, but we might as well update line 16 of the README to discord.unitary.foundation.

@jordandsullivan
Copy link
Collaborator Author

@Misty-W Should be all fixed now!

Copy link
Collaborator

@Misty-W Misty-W left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @jordandsullivan!

@jordandsullivan jordandsullivan merged commit a13183c into main Jan 18, 2025
1 check passed
@jordandsullivan jordandsullivan deleted the 167-add-readmemd-to-documentation branch January 18, 2025 06:46
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.

add README.md to documentation
2 participants