Skip to content
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.

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

Establish Five and a fake company as a narrative to facilitate docs comprehension #457

Open
leecalcote opened this issue Mar 14, 2025 · 2 comments
Labels
framework/hugo help wanted Extra attention is needed issue/willfix This issue will be worked on kind/enhancement Improvement in current feature language/css language/html language/javascript Javascript related

Comments

@leecalcote
Copy link
Member

leecalcote commented Mar 14, 2025

Current Behavior

It can be a challenge to document, screenshot, and explain features without a set of pre-established actors - a pre-established story with fake users, teams, and organizations in which to explain functionality. Lucky for us, we have an opportunity to create a continuous narrative in Layer5 Docs by incorporating our mascot, Five, into our docs.

Implementation

  1. Develop a small narrative around Five, his team, surrounding teams, and organization. This narrative can be illustrative in explaining features like workspaces, environments, users, teams, roles and so forth.
  2. Publish this narrative in both the Kanvas and Cloud doc sets.
  3. Start infusing this narrative into the documentation. Open new issues to suggest and track where our mascot can be helpful in explaining concepts.
  4. A collection of Five illustrations that can be sourced where approrpriate - https://layer5.io/company/brand (bottom of page)

Example

Microsoft documentation uses "Contoso" as a fake organization to aid in the explanation of concepts throughout its product docs.

Image

Contributor Guide and Resources

@leecalcote leecalcote added framework/hugo kind/enhancement Improvement in current feature language/css language/html language/javascript Javascript related help wanted Extra attention is needed labels Mar 14, 2025
@itsPronay
Copy link

@leecalcote can you assign me this one?

@leecalcote
Copy link
Member Author

Sounds great. Thanks much for jumping in and volunteering. In an effort to help guarantee your success in undertaking assignment of the issue, will you:

  1. confirm that you're able to build the project, specifically, the components necessary to resolve this issue.
  2. confirm the approach you intend to take to resolve the issue - a draft of the narrative would be great.

@leecalcote leecalcote added the issue/willfix This issue will be worked on label Apr 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework/hugo help wanted Extra attention is needed issue/willfix This issue will be worked on kind/enhancement Improvement in current feature language/css language/html language/javascript Javascript related
Development

No branches or pull requests

2 participants