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

DOCS issue #13: added libs and content for readthedocs integration #23

Merged
merged 10 commits into from
Nov 25, 2024

Conversation

u-ways
Copy link
Owner

@u-ways u-ways commented Nov 24, 2024

Context

This is a task worked on by @spyingcyclops
You can see the original PR here: #22

Original PR had prematurely merged a set of changes, so moving it here instead of asking them to resolve the conflicts for ease of contribution.

Summary

My first commit, please be kind & constructive :)

Done

  • Installed dependencies (mkdocs)
  • Prepared markdown files in /docs
  • Created readthedocs configuration files - mkdocs.yml, readthedocs.yaml

I don't know why the README shows changes - my local env says no change to that file

To build and preview the doc locally, run:

$ mkdocs build 
$ mkdocs serve

RE DoD, unit tests and linting are passing.

I would need help running the CI/CD tests locally.
I have not added tests to check the doc build, links, or other - I would need some guidance there

To Do:

Please follow the instructions in these sections to create an RTD account, and import the GitHub project.
creating-a-read-the-docs-account and importing-the-project-to-read-the-docs
I recommend using these project settings in RTD:

Optionally, you can also add me as a maintainer of the project and I can configure/test it.

Definition of Done Checklist:

  • Unit tests are added for new features. (newer projects)
  • Linting and formatting checks have passed.
  • CI/CD pipeline has been successfully executed.
  • If an interface has changed, documentation should be updated.

@u-ways u-ways force-pushed the readthedocs-feedback branch 8 times, most recently from d46a573 to 47aa753 Compare November 24, 2024 23:54
…reference our README, CONTRIBUTING and LICENSE page
@u-ways u-ways force-pushed the readthedocs-feedback branch from 47aa753 to 94b38ce Compare November 24, 2024 23:56
@u-ways u-ways force-pushed the readthedocs-feedback branch from e45c9aa to cdac2b7 Compare November 25, 2024 17:44
@u-ways u-ways force-pushed the readthedocs-feedback branch from 6374736 to 16cd3e7 Compare November 25, 2024 17:51
@u-ways u-ways changed the title DO NOT MERGE - Readthedocs PR Feedback & Testing DOCS issue #13: added libs and content for readthedocs integration Nov 25, 2024
@u-ways u-ways added the documentation Improvements or additions to documentation label Nov 25, 2024
@u-ways u-ways linked an issue Nov 25, 2024 that may be closed by this pull request
2 tasks
@u-ways u-ways merged commit cfee807 into main Nov 25, 2024
22 checks passed
@u-ways
Copy link
Owner Author

u-ways commented Nov 25, 2024

Merged this, thanks again @spyingcyclops !

@u-ways u-ways deleted the readthedocs-feedback branch November 25, 2024 17:58
@spyingcyclops
Copy link
Contributor

Ok, thank you, this is my first merged OSS contribution 🍾

cheers!

@u-ways
Copy link
Owner Author

u-ways commented Nov 25, 2024

@spyingcyclops - Amazing, I am sure many more to come!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

Documentation - Introduce docs.readthedocs.io for better readability
2 participants