Skip to content
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

Angular.dev: Missing Overview Page for Components #55685

Open
ToneyPK opened this issue May 6, 2024 · 3 comments
Open

Angular.dev: Missing Overview Page for Components #55685

ToneyPK opened this issue May 6, 2024 · 3 comments
Assignees
Labels
area: adev Angular.dev documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
Projects
Milestone

Comments

@ToneyPK
Copy link
Contributor

ToneyPK commented May 6, 2024

Describe the problem that you experienced

All other topics in the 'Docs' have an 'Overview' page except the https://angular.dev/guide/components page.
I think that we should add one to fit the existing structure but also to have a more welcoming page for beginners instead of going straight into the 'Anatomy of a component' topic.

The one from the old website https://angular.io/guide/component-overview is quite good in my opinion but could be also improved and added to the angular.dev website.

I also volunteer to write the page if we agree that this is a good idea.

Enter the URL of the topic with the problem

https://angular.dev/guide/components

Describe what you were looking for in the documentation

No response

Describe the actions that led you to experience the problem

No response

Describe what you want to experience that would fix the problem

Have an 'Overview 'page for 'Components' topic.

Add a screenshot if that helps illustrate the problem

No response

If this problem caused an exception or error, please paste it here

No response

If the problem is browser-specific, please specify the device, OS, browser, and version

No response

Provide any additional information here in as much as detail as you can

No response

@JeanMeche
Copy link
Member

AFAIK anatomy of a componet acts as an overview with multiple link to dedicated pages.

@ToneyPK
Copy link
Contributor Author

ToneyPK commented May 7, 2024

AFAIK anatomy of a componet acts as an overview with multiple link to dedicated pages.

Yes there are links but if you compare the old vs the new one I think you get what I am trying to say.
Also in the new docs, all other topics start by first briefly explaining what is the purpose of that particular topic, what it is and so on.

I just think that there is a missing intro paragraph that leads people to all the links and other existing content by addressing main questions about the topic.
I felt somehow just thrown into the Every component must have: sentence.

If this is intentional (maybe the Essentials page is supposed to cover this part) feel free to close this issue but I wanted to say that I found this weird and not as nice as in the old docs.

@pkozlowski-opensource pkozlowski-opensource added the area: adev Angular.dev documentation label May 16, 2024
@ngbot ngbot bot added this to the needsTriage milestone May 16, 2024
@bencodezen bencodezen added the P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent label May 20, 2024
@ngbot ngbot bot modified the milestones: needsTriage, Backlog May 20, 2024
@bencodezen
Copy link
Contributor

Thanks for the feedback @ToneyPK!

I can see how that isn't consistent across the guides. I'll work on making sure that consistency exists in the Component section as well while leveraging the work we've done in the Essentials guide.

@bencodezen bencodezen self-assigned this May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: adev Angular.dev documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
Projects
adev
Awaiting triage
Development

No branches or pull requests

4 participants