Skip to content

Docs: Refine Academy Publishing and Setup Guides #697

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
Merged
merged 3 commits into from
Jul 18, 2025
Merged

Docs: Refine Academy Publishing and Setup Guides #697

merged 3 commits into from
Jul 18, 2025

Conversation

zihanKuang
Copy link
Contributor

Notes for Reviewers

This PR fixes #696

This pull request refines the documentation for the Layer5 Academy.

  • Adds a "Prerequisites" section.
  • Unifies the content hierarchy to three levels: Path, Course, and Chapter.
  • Includes a concrete example of a learning path structure.
  • Rewrites the "Going Live" section for the new release-based workflow.
  • Adds detailed instructions for configuring GitHub Secrets.
  • Includes critical notes on correct token formatting.
  • Updates the local preview command to make serve.
  • Adds links to official Hugo documentation.
  • Includes a new FAQ section for troubleshooting.
  • Adds new images and a GIF to illustrate the process.

@zihanKuang
update
f33403a 
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
@zihanKuang
update
400c320 
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
@zihanKuang
update
b66ded0 
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
@netlify Netlify
Copy link

netlify bot commented Jul 18, 2025 •
edited
Loading

✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit b66ded0
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/687a0f0aa2415100084dc0b3
😎 Deploy Preview https://deploy-preview-697--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@zihanKuang zihanKuang merged commit 70a084c into layer5io:master Jul 18, 2025
6 checks passed
@zihanKuang zihanKuang deleted the improve-academy-docs branch July 18, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
component/cloud-docs component/kanvas-docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs] Update Documentation with New Details
1 participant
@zihanKuang