Skip to content

Update README with correct content hierarchy and documentation links #161

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

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README with correct content hierarchy and documentation links #161

wants to merge 2 commits into from

Conversation

Copy link
Contributor

Copilot AI commented Oct 30, 2025 •
edited
Loading

README.md contained outdated structure documentation, no reference to official docs, and failed to warn about deprecated features.

Changes

  • Content hierarchy: Documented correct structure as Learning Path → Course → Module with additional content types (Lab, Challenge, Test, Certification)
  • Deprecated features: Added warning that usestatic shortcode should not be used in new content
  • Documentation link: Added reference to https://docs.layer5.io/cloud/academy/ in Getting Started section
  • Contributor resources: Added links to contributing guide, example repository, Figma designs, and community channels (Discussion Forum, Slack)
  • Formatting: Restructured for clarity and markdown linting compliance
Original prompt

This section details on the original issue you should resolve

<issue_title>[Docs] README.md needs updating with correct information</issue_title>
<issue_description>#### Current State

  1. The directive usestatic is still referenced, but this is deprecated and should be removed.
  2. The current structure is documented as Learning Path → Course → Chapter → Lesson, which does not reflect the latest content hierarchy.
  3. There is no link to our official documentation site, which makes it harder for contributors and learners to find the most up-to-date resources.(should link to doc)
Image

Desired State

Contributor Guide and Resources

Comments on the Issue (you are @copilot in this section)

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@ritzorama ritzorama marked this pull request as ready for review October 30, 2025 20:52
Copilot AI changed the title [WIP] Update README.md to reflect correct information Update README with correct content hierarchy and documentation links Oct 30, 2025
Copilot finished work on behalf of ritzorama October 30, 2025 20:55
Copilot AI requested a review from ritzorama October 30, 2025 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ritzorama ritzorama Awaiting requested review from ritzorama

At least 1 approving review is required to merge this pull request.

Assignees

@ritzorama ritzorama

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Docs] README.md needs updating with correct information

2 participants

@ritzorama