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

UAPI docs update #223

Merged
merged 6 commits into from
Jul 1, 2024
Merged

UAPI docs update #223

merged 6 commits into from
Jul 1, 2024

Conversation

ziw-liu
Copy link
Collaborator

@ziw-liu ziw-liu commented Jun 12, 2024

No description provided.

@ziw-liu ziw-liu changed the base branch from main to unified-api June 12, 2024 21:23
@ziw-liu ziw-liu requested a review from ieivanov June 12, 2024 21:23
@ziw-liu ziw-liu marked this pull request as draft June 12, 2024 21:29
@ziw-liu
Copy link
Collaborator Author

ziw-liu commented Jun 12, 2024

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.

@ziw-liu ziw-liu added the documentation Improvements or additions to documentation label Jun 12, 2024
@ziw-liu ziw-liu marked this pull request as ready for review June 12, 2024 22:07
@ziw-liu ziw-liu requested a review from JoOkuma June 12, 2024 22:07
@ziw-liu ziw-liu added this to the 0.2.0 milestone Jun 27, 2024
Copy link
Contributor

@ieivanov ieivanov left a 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.

@ziw-liu
Copy link
Collaborator Author

ziw-liu commented Jun 28, 2024

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:

image

It can probably be improved by using different text.

@ziw-liu ziw-liu merged commit 80b6839 into unified-api Jul 1, 2024
7 checks passed
@ziw-liu ziw-liu deleted the uapi-docs-update branch July 1, 2024 21:19
@ziw-liu ziw-liu mentioned this pull request Jul 2, 2024
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.

2 participants