New structure

[RomainLanz]

Hey there! 👋🏻

Related: https://github.com/adonisjs/v6-docs/issues/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:

• [x] EdgeJS page
• [x] Lucid page
• [x] Write deployment guide
• [x] Fixing all the links

[cloudflare-pages[bot]]

Deploying v6-docs with    Cloudflare Pages

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

View logs

[Julien-R44]

Looks dope. I like it

[thetutlage]

Should we share it in the proposal thread? So that people can go through it and provide feedback

[Barbapapazes]

Hey, it looks nice!

Is there any particular reason on capitalize (instead of uppercase) HTTP?

And there is something broken in this page https://feat-new-structure.v6-docs.pages.dev/guides/preface/contribution-guide

[thetutlage]

It should be HTTP.

[aarhusgregersen]

Going through the docs, I have been unable to click a lot of links. It seems as if the navigation is broken on them?

• "Environment variables" under 'Getting started'
• "Application lifecycle" under 'Concepts'
• "Http overview" under 'Concepts'
• "Scaffolding" under 'Concepts'
• "Routing, "Controllers", "Middleware" and "Vite" under 'Basics'

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. It could be a separate item after Controllers, or mentioned within Routing or Controllers.

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? Thinking for example about how angular does it.

Just my two cents, great work overall! Really excited about this! 🙏

[RomainLanz]

Going through the docs, I have been unable to click a lot of links. It seems as if the navigation is broken on them?

Yeah, not sure what is going on. I have to troubleshoot. 😄

[RomainLanz]

It should be better now and all links should be correct.

[aarhusgregersen]

Links work! I still think that the Search bar should have a command short cut, and display it - if that is at all possible. Since mostly devs browse documentations, and we don't like taking our hands off the keyboard too much (generally speaking), having search be available from a shortcut is just a detail that leaves one impressed. What's more, a framework that cares about its devs by providing such a shortcut, says a lot of good things about the experience of then using the framework, doesn't it?

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). Maybe thats just me, so that's just some food for thought.

Again, overall I think they are already a ton better and this is tremendous work 🙏 🎉

[RomainLanz]

I still think that the Search bar should have a command short cut, and display it - if that is at all possible.

There is already, you can use CTRL-K to open the search bar.

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).

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.

[aarhusgregersen]

There is already, you can use CTRL-K to open the search bar.

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 😄

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.

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. Proceed as planned, nevermind me 😎

[RomainLanz]

Great! Is it possible to just type it out as part of the search placeholder?

Agree, but out of scope of this PR.

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 😄

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.

[Julien-R44]

there are still a few broken links left:

• https://feat-new-structure.v6-docs.pages.dev/guides/api-references/exceptions
• https://feat-new-structure.v6-docs.pages.dev/guides/api-references/edge

otherwise, i've just gone through the whole diff : looks perfect to me !

[thetutlage]

A few observations

• We should rename RC File -> AdonisRC file.
• Is Body parser two words or one? Is it BodyParser, Body Parser or Body-parser?
• The doc on Lucid ORM seems incomplete. It just shows how to create a model. If the goal is to have a small getting started guide for Lucid with AdonisJS, then it should cover the following topics.
  • Migrations
  • DB Query builder
  • Models
  • CRUD with models
• The Securing ssr doc should be Securing SSR. SSR is an acronym and should be in all caps.
• The API reference could be just Reference. With API Reference I expect the section to contain automatically generated API docs for the entire framework. Maybe my expectations are wrong.

[RomainLanz]

We should rename RC File -> AdonisRC file.

We are in the AdonisJS documentation. Would it make sense to rename it? It is, in the end, an RC file (runtime configuration file).

Is Body parser two words or one?

It is two worlds that can be linked with a dash -, so body-parser, body parser, and BodyParser are correct.

[thetutlage]

We are in the AdonisJS documentation. Would it make sense to rename it? It is, in the end, an RC file (runtime configuration file).

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

[RomainLanz]

Changed applied!

[thetutlage]

Looks great to me. Indeed feels more organized than the current version

[hiteshmungpara]

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.

[RomainLanz]

Nice ChatGPT skills.

Everything "you" are requesting is already available in the deployment page: https://docs.adonisjs.com/guides/getting-started/deployment

[hiteshmungpara]

thanks

i am not fluent in english that why i ask chatgpt to improve my suggestion.