Skip to content

[Docs] Improve Documentation for Sharing Functionality #548

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

Open
zihanKuang opened this issue May 7, 2025 · 0 comments · May be fixed by #554
Open

[Docs] Improve Documentation for Sharing Functionality #548

zihanKuang opened this issue May 7, 2025 · 0 comments · May be fixed by #554
Assignees
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown

Comments

@zihanKuang
Copy link
Contributor

The current "Sharing Designs" doc is too brief and UI-focused. It lacks explanation of background concepts, usage scenarios, and advanced behaviors. Key issues:

  1. Too Simplified: Only describes clicking "Share" without explaining when or why to share, or how sharing works in real cases.
  2. Missing Team Scenarios: No guidance on how designs inside a workspace become accessible to teams, or how team-level permissions work.
  3. No Visuals: No screenshots or diagrams. This makes it hard to follow.
  4. No Cross-Links: Doesn’t link to related pages like Workspace docs or Catalog.
  5. Structure Suggestion: Add a new section on "Sharing with Teams", or create a separate page like "Granting Access for Teams" and link from here.
@zihanKuang zihanKuang added area/docs Improvements or additions to documentation help wanted Extra attention is needed language/markdown framework/hugo labels May 7, 2025
@zihanKuang zihanKuang self-assigned this May 7, 2025
@zihanKuang zihanKuang linked a pull request May 11, 2025 that will close this issue
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

Successfully merging a pull request may close this issue.

1 participant