Skip to content

[Docs] Unlisting and centralizing the Contributing guide #491

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

Closed
leecalcote opened this issue Apr 23, 2025 · 1 comment
Closed

[Docs] Unlisting and centralizing the Contributing guide #491

leecalcote opened this issue Apr 23, 2025 · 1 comment
Assignees
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown

Comments

@leecalcote
Copy link
Member

leecalcote commented Apr 23, 2025

Current State

https://docs.layer5.io/kanvas/reference/contributing-to-docs/ is displayed under Kanvas product docs.

Desired State

  1. Ideally, this page is unlisted in the navbar, but is linked to from the footer and from CONTRIBUTING.md
  2. Ideally, this page is moved to a generic location (not under a specific product)
  3. Ideally, there are two contributing pages (or one page, but with the mechanics as secondary information):
    1. Writer's guide, inclusive of shortcodes and other resources specific to docs.layer5.io's framework.
    2. Mechanics of contributing (less important)

Contributor Guide and Resources

@leecalcote leecalcote added area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown labels Apr 23, 2025
@zihanKuang
Copy link
Contributor

This issue is closed as it was resolved by #520

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown
Projects
None yet
Development

No branches or pull requests

2 participants