layer5io / layer5io/docs

[Doc] Improve Documentation for Academy

Open
#835 9 comments 0 reactions 1 assignee Claimed by @Vanshikadahaliya View on GitHub
academy area/docs framework/hugo help wanted kind/bug language/css language/javascript
Dominant language
JavaScript
Stars
99
Forks
223
Avg merge
1d 1h
Merged PRs (30d)
17

Description

#### Current Behavior
- The documentation is outdated — missing updated images and new content related to the latest changes.
- The text-heavy guide takes a long time to follow, making it harder for learners to understand the process.

#### Expected Behavior
- Update the documentation with accurate content and current images to reflect the latest implementation.
- ⭐ Provide a short instructional video to guide users more effectively, as videos are quicker to follow and generally preferred by learners.

#### Screenshots/Logs
eg.

Image

#### Environment

- **Host OS:** Mac Linux Windows
- **Browser:** Chrome Safari Firefox Edge Opera

---

#### Contributor Guide and Resources
- 📚 [Instructions for contributing to documentation](https://github.com/layer5io/docs/blob/master/CONTRIBUTING.md)
- Layer5 documentation [site](https://docs.layer5.io) and [source](https://github.com/layer5io/docs/)
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.