Docs: New Getting Started Page

amplication / docs

Amplication docs

https://docs.amplication.com

Apache License 2.0

17 stars 62 forks source link

Docs: New Getting Started Page #538

Closed dericksozo closed 1 week ago

dericksozo commented 2 weeks ago

(docs): Adding the first draft of the new Getting Started page along with the new structure (draft).

dericksozo commented 2 weeks ago

Hey @PazYanoverr, this PR introduces a new Getting Started page draft that reorganizes our documentation structure. The proposed changes include:

New overview page highlighting key platform engineering capabilities
Restructured "Getting Started" sidebar section that will feature quickstart (first service creation), dedicated example services section, and In-depth Application introduction serving as documentation table of contents/roadmap

What are your initial thoughts on this first draft and this direction for the getting start sidebar re-structuring?

P.S. - There are some missing links because we'll need to merge the other PRs first.

PazYanoverr commented 1 week ago

@dericksozo - The "overview" page looks good! I added a few comments. Regarding the sidebar - I wish it reflects quickly Amplication major capabilities and advantages. A roadmap and examples are nice, but I think we need to "get to the point" much faster here. I.e., have here pages mostly about our live templates, technical debt handling, service catalog, and - maybe- plugins + private plugins. I believe these pages can also appear as part of the "regular" menu, but these issues should be emphasized in the documentation - i.e. in the sidebar menu, in the top menu etc. WDTY?

dericksozo commented 1 week ago

Hello @PazYanoverr,

I implemented the feedback into the Getting Started page. I added a new "Core Platform Features" section to the sidebar, showcasing Platform Console and Private Plugins pages. Once Live Templates and Service Catalog PRs are merged, they will be added to this section. We should also consider creating a dedicated Technical Debt Management page to complete the core feature documentation.

Thoughts?

PazYanoverr commented 1 week ago

@dericksozo - Sounds good. In addition- I fully agree regarding the Technical Debt Management page that should be created. Let's add it as a new task. One small comment: I think that the Documentation title should "hold" all the pages, not only the two pages of Overview and "Create your first..." -