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: initial addition of documentation #1

Merged
merged 7 commits into from
Aug 15, 2024

Conversation

nkapila6
Copy link
Collaborator

This PR includes the following.

  • Ported entire documentation from mlrose's sphinx implementation to a markdown based SSG: mkdocs
  • A couple of edits were required as the port wasn't clean.
  • Some of the markdown files needed to be written from scratch as I could not port them directly.
  • Changed all occurrences of 'mlrose' to 'mlrose-ky'
  • Added better navigation

The docs can be viewed here: mlrose-ky docs

@nkapila6
Copy link
Collaborator Author

nkapila6 commented Aug 14, 2024

I can't see an issue section in the repo.

The only question I have is what else is required to add? Apart from the below:

  • covering a tutorial on hiive's runners.
  • fixing the slug links, eg: url/post#h1

Could you list out your enhancements so I can start working on it? @knakamura13

@nkapila6 nkapila6 changed the title Initial addition of documentation docs: initial addition of documentation Aug 14, 2024
@knakamura13
Copy link
Owner

knakamura13 commented Aug 15, 2024

Could you list out your enhancements so I can start working on it?

Here's my list of tasks for this project. Task 1 is completed; tasks 2—4 are in progress.

  1. Fix all Python warnings and errors (except for some unavoidable warnings such as "duplicate code") ✅
  2. Add Python 3.10 type hints to all function and method definitions, plus all method properties (e.g., self.foo: str = 'bar')
  3. Add NumPy Doc docstrings to all functions and methods, plus at least a one-line docstring at the top of every file summarizing the file's contents
  4. Add tests using Pytest, aiming for 100% code coverage
  5. Search for TODO, FIXME, or other comments and resolve their respective issues
  6. Optimize vanilla Python loops that can be vectorized with NumPy
  7. Improve any other sub-optimal code, bugs, code quality issues, etc
  8. Remove any commented-out code

Copy link
Owner

@knakamura13 knakamura13 left a comment

Choose a reason for hiding this comment

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

lgtm

@knakamura13 knakamura13 merged commit 38832d3 into knakamura13:main Aug 15, 2024
2 checks passed
@nkapila6 nkapila6 mentioned this pull request Aug 18, 2024
5 tasks
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.

2 participants