Skip to content

Conversation

@kevinvandel
Copy link

No description provided.

@kevinvandel kevinvandel requested a review from GauBen as a code owner September 15, 2025 13:54
@kevinvandel
Copy link
Author

Actually, maybe it should link to /docs/1-getting-started/1-dev-environment/README.md?

@GauBen
Copy link
Member

GauBen commented Sep 15, 2025

Hi Kevin! This is intended, with https://github.com/Jahia/github-to-academy we properly resolve /cms links. You can see the result here: https://academy.jahia.com/tutorials-get-started/front-end-developer/introduction

@GauBen
Copy link
Member

GauBen commented Sep 15, 2025

What can we do to make it clearer that all markdown files are rendered and pushed to the academy?

@kevinvandel
Copy link
Author

Oh ok, so if I get it right, the readme files here are not intended to be read directly, but they are used to populate the Academy.

What can we do to make it clearer that all markdown files are rendered and pushed to the academy?
Good question... Ideally, I would think of a warning block at the beginning of each file stating that it is not intended to be read here and linking to the related Academy page, but maybe it's too much (and I guess it would be painful to set up).

@GauBen
Copy link
Member

GauBen commented Sep 15, 2025

I hoped the frontmatter made it clear, but there's always room for improvement

image

I however don't want this burden to be on the documentation editor, it's already painful to update the academy 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants