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: formatting updates to api reference #276

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ericmariasis
Copy link
Contributor

Commit Message

This commit makes the resource names larger and more readable as well as some other header fields.
In addition, there is now a "back to top" button at the bottom of the page.

Related Issues/PRs (if applicable)

Fixes issue #241.

@ericmariasis ericmariasis requested a review from a team as a code owner February 2, 2025 21:49
@mathetake
Copy link
Member

@ericmariasis Hey, please do not repeat many times again. The CI clearly says you are NOT making sure make precommit on your local machine as instructed in CONTRIBUTING.md as well as pull request templates. Please do follow the instruction to avoid wasting my time and anyone following this repository.

@mathetake mathetake marked this pull request as draft February 2, 2025 21:54
@ericmariasis
Copy link
Contributor Author

Some past comments are in PR 271.

@mathetake mathetake removed the request for review from a team February 2, 2025 21:56
@mathetake
Copy link
Member

You shouldn't have recreated another PR that has been doing exactly the same thing. There's absolutely no reason to do that under any circumstances. Even if that is ok, how do you think (new) in the title will be helpful as a commit message if you see in the commit message in the future. No making sense.

@ericmariasis ericmariasis marked this pull request as ready for review February 2, 2025 23:31
@missBerg missBerg changed the title docs: formatting updates to api reference (new) docs: formatting updates to api reference Feb 4, 2025
@missBerg missBerg added the documentation Improvements or additions to documentation label Feb 4, 2025
@missBerg
Copy link
Contributor

missBerg commented Feb 4, 2025

Looking at the output the changes generate, think we may need to think about how we can organize these better.
I'll slack you @ericmariasis and see what we can come up with!

@missBerg missBerg marked this pull request as draft February 4, 2025 16:50
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
None yet
Development

Successfully merging this pull request may close these issues.

3 participants