Skip to content

Update Academy First Page #57

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

vr-varad
Copy link
Contributor

@vr-varad vr-varad commented Aug 5, 2025

Notes for Reviewers

This PR updates the first visible page of academy with important info.

image

Signed commits

  • Yes, I signed my commits.

Signed-off-by: vr-varad <[email protected]>
Signed-off-by: vr-varad <[email protected]>
@leecalcote
Copy link
Member

It's a fine line between convenience of info and duplication of info (more maintenance) - difficult to navigate.

<a href="https://github.com/layer5io/academy-theme">academy-theme</a>
provides the core layout, style, and features for your learning path. Regularly updating it ensures you benefit
from
the latest improvements and bug fixes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we hardcode the latest version?

Comment on lines +63 to +66
You can
place custom
Hugo
Shortcodes here if you need special reusable components.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems they are listed on one line in your screenshot?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which is good. They shouldn't be on multiple lines here, though.... at least not in terms of cleanliness. They render on a the same line, which makes this acceptable.

Shortcodes here if you need special reusable components.
</li>
</ul>
<h5>Content Hierarchy</h5>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is incomplete.

Either the rest of the content types need to be represented or a note needs to be included to say that this is only part of what is supported and a hyperlink included to Layer5 Docs with the full list.

@Vincamine Vincamine requested a review from leecalcote August 9, 2025 20:10
@Vincamine
Copy link
Contributor

  1. I’m wondering if we should include so much information on the landing page. We could explain things concisely and link to our documentation for details. Here, we can leave a simple workflow.
  2. As a reminder, after modifying this landing page, we need to share it across all academy-related repositories.

@vr-varad
Copy link
Contributor Author

vr-varad commented Aug 9, 2025

  1. I’m wondering if we should include so much information on the landing page. We could explain things concisely and link to our documentation for details. Here, we can leave a simple workflow.
  2. As a reminder, after modifying this landing page, we need to share it across all academy-related repositories.

Ya, I agree with you @Vincamine
I kept only what might be helpful, like to content and file structure for academy and for rest i have added a link for docs.

Signed-off-by: Varad Gupta <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants