yew
yew copied to clipboard
[Tracking issue] Website/documentation overhaul
Our documentation has many areas which need improvement. In no particular order, following is a list of (some of) them/their solutions:
- [x] Tutorial should be more visible. A button in a nav bar would do the job. (use swizzling to make the button respond to current version) - https://github.com/yewstack/yew/pull/2391
- [ ] Hide version drop down on home page (needs swizzling, as far as i'm aware)
- [x] Introduction pages should be category links (https://docusaurus.io/docs/sidebar#category-link) - https://github.com/yewstack/yew/pull/2321
- [x] Read through getting started documentation and remove duplication - https://github.com/yewstack/yew/pull/2321
- [ ] Collapsible code blocks to have the entire code there and be tested (https://github.com/facebook/docusaurus/pull/5783)
- [x] Reorganize (where needed). New React docs are a good inspiration for this - https://github.com/yewstack/yew/pull/2321
- [ ] ~~Use multi-docs for router docs (https://docusaurus.io/docs/docs-multi-instance)~~ reconsider this because of versioning
- [x] Add a blog. Even if there won't be frequent posts, a blog post for release sounds good to have. - https://github.com/yewstack/yew/pull/2391
- [x] https://github.com/yewstack/yew/issues/2383
- [x] https://github.com/yewstack/yew/issues/2503
- [ ] #2322
- [ ] Fix up confusing/lacking documentation:
- [ ] #2197, #905
- [x] #2189
- [x] #2180
- [x] #1843
- [x] #2376
- [x] #2385
- [x] #2386
Woah new react docs really look awesome!
@hamza1311 I think we need a checkbox for making variations for 2 different flavors of creating components everywhere Preferably function components flavor shown on render
@hamza1311 I think we need a checkbox for making variations for 2 different flavors of creating components everywhere Preferably function components flavor shown on render
@voidpumpkin, shouldn't we be removing struct components from docs as per #2282?
@hamza1311 Oh i misunderstood that discussion completely then. Yes I'm up with removing struct components from docs (maybe just leaving a small section to cover their specifics).
Those new react docs look so good i almost want to just copy paste everything :D But i think I'm not allowed, license is very vague :( https://github.com/reactjs/reactjs.org/blob/main/LICENSE-DOCS.md
I saw that a blog was added with a placeholder post.
Could the project keep incomplete pages off of the official site until they're ready for publication? Perhaps there can be a staging site or a test directory for posts to be worked on.
I saw that a blog was added with a placeholder post.
Could the project keep incomplete pages off of the official site until they're ready for publication? Perhaps there can be a staging site or a test directory for posts to be worked on.
I don't think that was considered a placeholder post. We already have separate environments for PRs so I'm not sure whether we really need a persistent staging site.
We need a task to investigate/make run docs tests in wasm target as currently we cant have wasm_bindgen stuff inside code snippets.
Created issue: #2503
I been 3 days looking for example nginx configs specially to doublecheck mine and see if I need to change anything since I do not want to run yew with its own webserver when nginx is capable of this for a frontend app, only the backend should be listening to a different port like :8000 https://github.com/yewstack/yew/issues/2376#issuecomment-1650603566 btw if someone could point me to one I will be gratefull since my nginx config works but websocket is not working, I need a entry on nginx for that I think.