-
Notifications
You must be signed in to change notification settings - Fork 7
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
UAPI docs update #223
UAPI docs update #223
Conversation
Just realized that the docs website will not retain the stable version when UAPI merges to main. Let me try to fix that in this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll approve it, but I haven't fully tested this PR. Feel free to merge if you know it works or if you prefer, let me know how I should test it.
Possibly a separate issue - is there a way we can make the documentation more easily accessible? Currently I scroll halfway down the readme on the github page to find the documentation link. Maybe I'm doing it wrong? Is there a way we can add a link closer to the top of the page? And as I'm writing this I see that there is a link just under the About section. Maybe ignore this, but I think @talonchandler also had a similar issues of not having a convenient link to the docs.
To test it you will have to build it locally. In this case I am also not sure how it work out until its merged to main and deployed, since GH pages don't support previews. So I will just merge. As for the link, the docs badge at the top of README links to documentation: ![]() It can probably be improved by using different text. |
No description provided.