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

doc/site: Components should link to component - specific documentation #226

Open
fgheysels opened this issue Jun 7, 2022 · 4 comments
Open
Assignees
Labels
documentation All issues related to documentation proposal

Comments

@fgheysels
Copy link
Member

On the Arcus website (https://arcus-azure.net), we have a section that lists all the components.

When you click on one of those components, you get redirected to the github project page.
Wouldn't it be better if we link to the component-specific documentation for that component instead ? For instance, if you click on 'Security', you get redirected to security.arcus-azure.net instead of being redirected to https://github.com/arcus-azure/arcus.security

@fgheysels fgheysels added documentation All issues related to documentation proposal labels Jun 7, 2022
@stijnmoreels
Copy link
Member

Absolutely! Should indeed be redirected to the docs site of the component. The docs sites also seems like a great start point to learn more about the library instead of the GitHub page. 👍

@stijnmoreels
Copy link
Member

Not sure though, if we (or I) can already take action on this are we are migrating towards our new general documentation site.

@fgheysels
Copy link
Member Author

When is the new general doc site due ?

@stijnmoreels
Copy link
Member

When is the new general doc site due ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation All issues related to documentation proposal
Projects
None yet
Development

No branches or pull requests

2 participants