Skip to content

Revise README for clarity and structure #121

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.

Sign up for GitHub

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
leecalcote wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Revise README for clarity and structure #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@

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

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

Typo: "cirricula" should be "curricula" (or rephrase to "creating curricula").

Suggested change
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.

Copilot uses AI. Check for mistakes.

This guide will walk you through setting up your own content repository, creating courses, and previewing them locally.
---

> For more in-depth documentation, see the official [Layer5 Academy docs](https://docs.layer5.io/cloud/academy/).
<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>
Comment on lines +8 to +10
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

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).

Suggested change
<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/).

Copilot uses AI. Check for mistakes.

---

## Prerequisites

Before you begin, ensure you have the following installed on your system:

* [**Hugo**](https://gohugo.io/getting-started/installing/) (extended version) （version 0.147.9）
* [**Go**](https://go.dev/doc/install) （version 1.12）
1. [**Go**](https://go.dev/doc/install)
2. [**Hugo**](https://gohugo.io/getting-started/installing/) (extended version)
Comment on lines +18 to +19
Copy link

Copilot AI Apr 8, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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`)

Copilot uses AI. Check for mistakes.

## Getting Started

Expand Down
Loading