-
Notifications
You must be signed in to change notification settings - Fork 149
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
Doc Structure Improvements #704
Comments
Fixed links and added redirects in the short term. Should be working now. Just forgot to update the homepage lol. |
Any thoughts on my thoughts? Totally up for collaborating on docs, esp if it gives you more time on the code 😊 |
Sorry, woke up to several comments from people telling me the docs were broken lol, so my goal was to get that resolved first. Haven't had time to go through your comment in detail, will do it today after work! Thanks for the in-depth comment though, and I appreciate your offer to help restructure it. I've been swamped with tickets and help requests on discord, and I haven't had time to actually work on the framework for a while. So any kind of help would be appreciated. I needed to shake things up and try something else for the docs website. That's why I just did it out of the blue yesterday. |
That sounds promising! OK, no hurry, have a great day |
I like the separate "Get Started" and "guide" sections, because no developer will be able to read through all the docs at once. There's too much. Instead, just read the smaller "Get Started" pages from start to finish so you have an understanding of the framework, then look at the guide for more details. I think duplicate content is just a side effect of this approach. I would prefer to avoid this if possible, but need help finding a better structure.
I can't explain all of extension development in my docs, you have to assume a certain knowledge level, and my assumption is that you know how chrome extensions function. Not really sure how to improve this, but I have been getting too many basic questions below that knowledge level assumption, so any ideas you have around this would be great.
I actually HATE the vitepress docs, I can never find what I need, at least around customizing the default theme. The rest of their docs are pretty solid, but I never know if the default theme info is in the guide or the API reference. Usually in the API reference, but none of that code mentions any API. Both Nuxt and Astro have a single section basically, where all the concepts are listed in the sidebar. Don't mind this, but isn't it too much for a first time reader? There's no way I can get through all that stuff. I'm gonna end up picking and choosing different pages as needed instead of getting a comprehensive overview of what I need to know. |
Dave said:
Aaron replied:
So I'll toss this out: you both might enjoy this breakdown of documentation if you've not seen it before. In support of this issue but far beyond the scope of "just" this issue... it's a good read IMO. I always encourage folks to start on the right side of the axis and trend to the bottom. Universally, I think everyone needs reference and then when you work backwards from that how-to guides are the easiest to knock out. |
Hey @aklinker1, Thanks for your notes! I think we're actually aligned on the key points:
And I should like to say also, credit to your hard work; you've documented a lot and it is very nicely-written 🙏 Having gone through your new docs again I'm pretty sure I could build on what exists – so how about I just fork and iterate on a new structure? I'm pretty sure I can find a route through that will work for both window-shoppers and those planning to make a more long-term investment in the framework, whilst addressing the key issues of discovery, fragmentation and duplication. I could get a first pass up and running in the next couple of days, then we go from there, if that works? And if you don't like it, no big loss; at least it means one more person will have read all the docs! |
Thank you! Other than the typos 🙈 I've been using Zed lately, and it doesn't have a spell check extension yet... Or it didn't a month ago last time I checked.
I've never done this, but I don't really want the overhead of maintaining what I imagine an injected setup would look like, so let's keep it vanilla for now.
@davestewart yup, I think we're aligned, and I think that's a great idea! LMK if you have any questions as you go through them more. Only thing to point out is the |
@leetrout Thanks for sharing! I've started reading through it, but it's like a small book lol. Haven't gotten to any actionable steps, just reading about the 4 different types of documentation. Hopefully we can apply some of those learnings on the upcoming improvements. |
Hey @davestewart, I think I'm gonna start updating the structure a bit, and if you have time, I'd like your feedback!
Here's my plan:
Here's a rough outline of what the sections will be:
I think that should cover everything for I am beginning to release first-party packages you can use with WXT, like |
Hey @aklinker1, Sorry for the late reply and lack of input, work (and, actually some fun OSS, finally!) has been rather all-consuming over the last couple of months! I think this sounds really good. I might suggest the following though:
In summary:
Really, I'm just thinking though probably the development process I would go through when piecing together the parts of an extension I might build, i.e. the floor before the walls, etc. and where I would be in the docs. My two main main beefs with the Nuxt docs were:
I think the "Entrypoints" section could easily be explained on a single page with a "concept" explainer, and either subsections, a table or two, or links to the API, for the various flavours. FWIW I think a Quick Start section could still work:
I get there could be a crossover with the Examples section; perhaps the Examples is effectively the "Further reading" for this section. |
@davestewart Thanks for the feedback! I worked on it the last few days, and a partial version of the new docs is live, with a few changes from what I originally posted. https://deploy-preview-933--creative-fairy-df92c4.netlify.app/ I think it aligns with some of the changes you suggested |
Describe the bug
Go to any sub-page on https://wxt.dev and it's a 404.
EDIT 1: only seems to happen if navigating from the Get Started or Learn More buttons on the home page. The top nav menus seem to be OK.
EDIT 2: But, also happened from Google search results:
It seems maybe the
getting-started
andguide
links are pointing at the wrong folders?Get Started:
EDIT 3: looks like #701 broke this, so fix needed + 301 redirects.
Reproduction
https://wxt.dev/guide/installation.html
The text was updated successfully, but these errors were encountered: