Skip to content

Update Academy First Page - #57

Closed
vr-varad wants to merge 5 commits into
layer5io:masterfrom
vr-varad:fix/first_page
Closed

Update Academy First Page#57
vr-varad wants to merge 5 commits into
layer5io:masterfrom
vr-varad:fix/first_page

Conversation

@vr-varad

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

Copy link
Copy Markdown
Contributor

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 <varadgupta21@gmail.com>
Signed-off-by: vr-varad <varadgupta21@gmail.com>
Signed-off-by: vr-varad <varadgupta21@gmail.com>
@leecalcote

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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.

Comment thread layouts/shortcodes/org/info.html Outdated
Signed-off-by: Horti <160366376+hortison@users.noreply.github.com>
Shortcodes here if you need special reusable components.
</li>
</ul>
<h5>Content Hierarchy</h5>

Copy link
Copy Markdown
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
Copy Markdown
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.

Comment thread layouts/shortcodes/org/info.html Outdated
@vr-varad

vr-varad commented Aug 9, 2025

Copy link
Copy Markdown
Contributor Author
  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 <114755221+vr-varad@users.noreply.github.com>
@Vincamine

Vincamine commented Aug 18, 2025

Copy link
Copy Markdown
Contributor

Hi team, thanks for the effort on this! For an effective Academy landing page, I have a few considerations:

On the content:

  1. This is the landing page for academy-example. It should stay focused on showing what content developers can do. Details about it belong in the docs, not here.
  2. Since users have already forked academy-example by the time they land here, this page should simply point them to the official Docs(with reminders) rather than listing too much info.
  3. Adding “tutorial-level” instructions on the landing page risks going out of date and creates duplication. Detailed guidance should live in the Docs.
  4. The current content fills the page and feels 'heavy' to read. The hierarchy examples are not very intuitive and can add confusion.
  5. The landing page should just serve as an entry point with a short explanation and a clear CTA.

On the location:

  1. This is a single-use block; a shortcode adds unnecessary indirection without any reuse benefit.
  2. Page-scoped content keeps the impact limited.
  3. Landing pages should remain concise and route users to the Docs, not duplicate them.

Thus, I’ll close this PR and submit a follow-up with a clear CTA to the Docs. If styling is needed, we can handle that via CSS or a page-specific partial instead of wrapping the content in a shortcode.

@Vincamine Vincamine closed this Aug 18, 2025
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