Conversation
Updated the README to clarify the purpose and instructions for creating a dedicated academy on Layer5 Academy. Enhanced formatting and added links for better navigation. Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
There was a problem hiding this comment.
Pull request overview
This PR updates the repository README to better explain how to use this template to create a dedicated Layer5 Academy content repository, with improved structure and navigation.
Changes:
- Rewrote the introductory description for clarity and added section dividers.
- Replaced the docs note with a centered, linked callout.
- Reformatted the prerequisites section into a numbered list.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Layer5 Academy - Content Starter Template | ||
|
|
||
| This repository is a starter template for creating custom learning paths and courses on the [Layer5 Academy](https://cloud.layer5.io/academy/overview). It provides the necessary file structure and a working example to help you get started quickly. | ||
| This repository offers a starter template for creating your own, dedicated academy on the [Layer5 Academy](https://cloud.layer5.io/academy/overview) platform. This repository provides the necessary file structure and a working example to help you get started quickly. The guide below offers a quick start to setting up your own content repository, creating cirricula, and previewing your academy locally. |
There was a problem hiding this comment.
Typo: "cirricula" should be "curricula" (or rephrase to "creating curricula").
| This repository offers a starter template for creating your own, dedicated academy on the [Layer5 Academy](https://cloud.layer5.io/academy/overview) platform. This repository provides the necessary file structure and a working example to help you get started quickly. The guide below offers a quick start to setting up your own content repository, creating cirricula, and previewing your academy locally. | |
| This repository offers a starter template for creating your own, dedicated academy on the [Layer5 Academy](https://cloud.layer5.io/academy/overview) platform. This repository provides the necessary file structure and a working example to help you get started quickly. The guide below offers a quick start to setting up your own content repository, creating curricula, and previewing your academy locally. |
| 1. [**Go**](https://go.dev/doc/install) | ||
| 2. [**Hugo**](https://gohugo.io/getting-started/installing/) (extended version) |
There was a problem hiding this comment.
The prerequisites list no longer states version requirements, but the repo enforces specific minimums (Hugo extended min 0.146.0 in hugo.yaml and Go version in go.mod). Please add the relevant minimum versions (or point readers to these files) to avoid setup issues due to incompatible toolchains.
| 1. [**Go**](https://go.dev/doc/install) | |
| 2. [**Hugo**](https://gohugo.io/getting-started/installing/) (extended version) | |
| 1. [**Go**](https://go.dev/doc/install) (use the version required by the root `go.mod` file) | |
| 2. [**Hugo**](https://gohugo.io/getting-started/installing/) (extended version, minimum `0.146.0` as defined in `hugo.yaml`) |
| <p align="center"> | ||
| 💡ℹ️ FOR IN-DEPTH TUTORIAL AND CUSTOMIZATION EXAMPLES, SEE THE <a href="https://docs.layer5.io/cloud/academy/">LAYER5 ACADEMY DOCS</a>. ℹ️💡 | ||
| </p> |
There was a problem hiding this comment.
The centered callout uses emojis and ALL CAPS text inside raw HTML. This can reduce readability/accessibility and may render inconsistently across Markdown viewers. Consider switching to a standard Markdown blockquote/admonition style with normal casing (while keeping the link).
| <p align="center"> | |
| 💡ℹ️ FOR IN-DEPTH TUTORIAL AND CUSTOMIZATION EXAMPLES, SEE THE <a href="https://docs.layer5.io/cloud/academy/">LAYER5 ACADEMY DOCS</a>. ℹ️💡 | |
| </p> | |
| > For in-depth tutorials and customization examples, see the [Layer5 Academy docs](https://docs.layer5.io/cloud/academy/). |
Notes for Reviewers
Updated the README to clarify the purpose and instructions for creating a dedicated academy on Layer5 Academy. Enhanced formatting and added links for better navigation.
Signed commits