From 1fb04f0d0b52701bf71635abf263f0c92bb01e95 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:48:50 +0000 Subject: [PATCH 1/2] Initial plan From a46bb58ad97421f2a0683c41ee8f736f78fd4192 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:53:08 +0000 Subject: [PATCH 2/2] Update README.md with correct information and structure Co-authored-by: ritzorama <182301570+ritzorama@users.noreply.github.com> --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 49 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0a9a4e4..0573519 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,52 @@ -Reusable hugo theme module that powers the layer5 academy . -this modules provides the layouts , shortcodes and partials to get academy up and running +# Academy Theme -The recommended approach to use this theme is through the academy starter template . +Reusable Hugo theme module that powers the Layer5 Academy. This module provides +the layouts, shortcodes, and partials to get academy up and running. -## Getting started with this theme +## Getting Started -The recommended approach to use this theme is through the academy starter template . +The recommended approach to use this theme is through the +[academy starter template](https://github.com/layer5io/academy-example). + +For comprehensive documentation, visit the +[official Academy documentation](https://docs.layer5.io/cloud/academy/). + +## Content Structure + +The Academy uses the following content hierarchy: + +### Learning Path β†’ Course β†’ Module + +In addition to this core structure, the following content types are available: + +- **Lab** - Hands-on practical exercises +- **Challenge** - Skill assessment challenges +- **Test** - Knowledge assessments (test, optional-test, + final-test) +- **Certification** - Certification programs + +## Important Notes + +⚠️ **Deprecated Features** + +- The `usestatic` shortcode is deprecated and should not be used in new + content. + +## Contributor Guide and Resources + +- πŸ“š [Instructions for contributing to academy-example][contrib] + - Academy-template [documentation][docs], [example][example], and + [theme][theme] +- 🎨 Wireframes and [designs for Layer5 site][figma] in Figma + ([open invite][figma-invite]) +- πŸ™‹πŸΎπŸ™‹πŸΌ Questions: [Layer5 Discussion Forum][forum] and + [Layer5 Community Slack][slack] + +[contrib]: https://github.com/layer5io/academy-example/blob/master/CONTRIBUTING.md +[docs]: https://docs.layer5.io/cloud/academy/ +[example]: https://github.com/layer5io/academy-example/ +[theme]: https://github.com/layer5io/academy-theme/ +[figma]: https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs +[figma-invite]: https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9 +[forum]: https://discuss.layer5.io +[slack]: http://slack.layer5.io