-
-
Notifications
You must be signed in to change notification settings - Fork 58
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
New structure #86
New structure #86
Conversation
Deploying v6-docs with
|
Latest commit: |
2e73498
|
Status: | ✅ Deploy successful! |
Preview URL: | https://8094d928.v6-docs.pages.dev |
Branch Preview URL: | https://feat-new-structure.v6-docs.pages.dev |
023f3c7
to
0464e97
Compare
Looks dope. I like it |
Should we share it in the proposal thread? So that people can go through it and provide feedback |
This comment was marked as resolved.
This comment was marked as resolved.
It should be |
Going through the docs, I have been unable to click a lot of links. It seems as if the navigation is broken on them?
As I'm unable to read through the docs on this matter (Routing and or Controllers), it's hard to know if this is relevant, but from the layout of the docs it might be nice to have some sort of brief explanation about views near these two items. To me that seems quite intuitive because that means the docs will guide me through the relevant/necessary parts to render things in my browser. Otherwise I think its great, I really like the sections and for someone who had a bit of a tough time navigating the docs not too far in the past I find this to be a huge upgrade. Is it possible to add a short-cut to search, and perhaps have that command be part of the placeholder in the search bar? Just my two cents, great work overall! Really excited about this! 🙏 |
Yeah, not sure what is going on. I have to troubleshoot. 😄 |
It should be better now and all links should be correct. |
Links work! I was trying to read through "Routing", "Controllers", "Request" and "Response" in order to find a 'natural' entry into views. Maybe it's just me, but while I like that views have its own section, it's also a bit weird I'm not guided or nudged to go there, through one of the related items (eg. Controllers). Again, overall I think they are already a ton better and this is tremendous work 🙏 🎉 |
There is already, you can use CTRL-K to open the search bar.
Maybe we can add a few sentences that link to the section from there. The point is, not everyone is making an application that render HTML. |
Great! Is it possible to just type it out as part of the search placeholder? I appreciate that it's already an option, and maybe this is so standard it doesn't need to be said, but very cool its an option 😄
That's a great point. Sometimes I forget MVC frameworks can also be used to provide a stable API, microservice, message queue or a 100 other things. |
Agree, but out of scope of this PR.
It is the shortcut of Algolia Search, it is the same in all documentation website you are using. I have added the missing sections. I believe we can merge this and refine/improve the documentation from this point. |
there are still a few broken links left:
otherwise, i've just gone through the whole diff : looks perfect to me ! |
A few observations
|
We are in the AdonisJS documentation. Would it make sense to rename it? It is, in the end, an RC file (runtime configuration file).
It is two worlds that can be linked with a dash |
But RC file could mean a lot of things. PrettierRC file, NpmRC file and so on. Even though we are in the AdonisJS docs, the file name should be complete in itself. For example: https://docs.npmjs.com/cli/v10/configuring-npm/npmrc |
Changed applied! |
Looks great to me. Indeed feels more organized than the current version |
Suggestion: In the TypeScript build process page, it would be beneficial to include separate deployment sections. These sections could encompass configurations for various deployment environments such as Nginx and Docker, providing users with clear guidance on deploying their TypeScript applications effectively. Additional Suggestion: Moreover, considering the growing popularity of AdonisJS 6, it could be valuable to integrate specific deployment guidelines tailored to this framework within the deployment sections. Including instructions on optimizing deployment processes, setting up AdonisJS 6 applications within Docker containers, and configuring Nginx for efficient routing could further enhance the resource's utility and relevance. |
Nice ChatGPT skills. Everything "you" are requesting is already available in the deployment page: https://docs.adonisjs.com/guides/getting-started/deployment |
thanks i am not fluent in english that why i ask chatgpt to improve my suggestion. |
Hey there! 👋🏻
Related: #80
I open this PR "as draft" so we can see the new structure live and already give some feedback.
The current missing parts are: