Skip to content

Final documentation touch ups & tag 0.19.0#2220

Merged
ranile merged 7 commits into
yewstack:masterfrom
ranile:touch-docs
Nov 29, 2021
Merged

Final documentation touch ups & tag 0.19.0#2220
ranile merged 7 commits into
yewstack:masterfrom
ranile:touch-docs

Conversation

@ranile
Copy link
Copy Markdown
Member

@ranile ranile commented Nov 29, 2021

Description

Fix minor documentation issues and some pages

Checklist

  • I have run cargo make pr-flow
  • I have reviewed my own code
  • I have added tests

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 29, 2021

Visit the preview URL for this PR (updated for commit 2eaf4d3):

https://yew-rs--pr2220-touch-docs-908o6ntf.web.app

(expires Mon, 06 Dec 2021 18:50:58 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@Madoshakalaka
Copy link
Copy Markdown
Member

Tried in the preview website, if you have closed the sidebar by clicking the logo on the upper left. There is no apparent way of bringing back the side menu. I tried a bit and found that clicking on the version button and the docs button actually brings out the sidebar. But they make the current page jump...

image

(say if you are on "using trunk" page, clicking on "Docs" jumps you to introduction, and clicking on the version selector jumps you to "Build a sample app")

image

In comparison, https://docusaurus.io/docs has buttons to exand and close the side bar

image

image

Also the bot now needs to append /next/getting-started/project-setup/introduction to the preview url?

@ranile
Copy link
Copy Markdown
Member Author

ranile commented Nov 29, 2021

@Madoshakalaka, I fixed the next redirect issue. Also, the docs button properly highlights now.

The issue you're describing with not being able to show sidebar is different. The home page is now an actual page now instead of a docs redirect. You can navigate to docs page by clicking the docs button in the navbar. I think the issue here is that you're used to the old design and new one feels "wrong"

@Madoshakalaka
Copy link
Copy Markdown
Member

@hamza1311 alright, sounds good

now that home is its own page, docs should be under `/docs/`
@ranile ranile requested review from mc1098 and voidpumpkin November 29, 2021 17:22
Copy link
Copy Markdown
Member

@voidpumpkin voidpumpkin left a comment

Choose a reason for hiding this comment

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

Looks good, could we add the 0.19.0 tag at the top with this PR aswell?

@ranile
Copy link
Copy Markdown
Member Author

ranile commented Nov 29, 2021

Sure, I can add that but changing docs after that is gonna be inconvenient

@voidpumpkin
Copy link
Copy Markdown
Member

Sure, I can add that but changing docs after that is gonna be inconvenient

Why? I believe its possible to just add a version without copying all files, right?

@ranile
Copy link
Copy Markdown
Member Author

ranile commented Nov 29, 2021

The command will create a copy of all the files and add a new version

@voidpumpkin
Copy link
Copy Markdown
Member

The command will create a copy of all the files and add a new version

Hmm i guess we have no other option, we want to serve 0.19 as default when people come to the page

@voidpumpkin
Copy link
Copy Markdown
Member

But probably thats a diffrent PR then

voidpumpkin
voidpumpkin previously approved these changes Nov 29, 2021
@ranile
Copy link
Copy Markdown
Member Author

ranile commented Nov 29, 2021

Well, I did it now. We can just roll with it. Instead of changing anything else, let's release now

@voidpumpkin
Copy link
Copy Markdown
Member

@hamza1311 Change the PR header then aswell

@ranile ranile changed the title Fix minor documentation issues Final documentation touch ups & tag 0.19.0 Nov 29, 2021
@ranile
Copy link
Copy Markdown
Member Author

ranile commented Nov 29, 2021

@voidpumpkin done

@ranile ranile merged commit 996bf5b into yewstack:master Nov 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants