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

Community Survey to Improve Docs #2004

Open
5 tasks done
christiannwamba opened this issue Jan 13, 2025 · 1 comment
Open
5 tasks done

Community Survey to Improve Docs #2004

christiannwamba opened this issue Jan 13, 2025 · 1 comment
Assignees
Labels
feat New feature or request.

Comments

@christiannwamba
Copy link
Contributor

christiannwamba commented Jan 13, 2025

Preflight checklist

Ory Network Project

No response

Describe your problem

Documentation needs improvement based on user feedback. Key signals include:

  • Users report difficulty finding code examples
  • Structure can be confusing
  • Navigation between related topics is challenging
  • Setup and implementation guides are mixed together
  • API documentation needs enhancement

Describe your ideal solution

Create and distribute a comprehensive survey to gather user feedback on:

  • Documentation structure preferences
  • Content discovery patterns
  • API documentation needs
  • Feature vs solution-based navigation
  • Overall satisfaction and pain points

Workarounds or alternatives

N/A

Version

N/A

Additional Context

No response

@christiannwamba christiannwamba added the feat New feature or request. label Jan 13, 2025
@christiannwamba christiannwamba self-assigned this Jan 13, 2025
@vinckr
Copy link
Member

vinckr commented Jan 13, 2025

To track distribution:

  • newsletter @jfcurran
  • announcement in community slack @vinckr
  • pinned posts in community slack main channels @christiannwamba (you post, I pin them)
  • pinned discussions on github for /kratos @vinckr
  • pinned discussions on github for /hydra @vinckr
  • pinned discussions on github for /keto @vinckr
  • pinned discussions on github for /oathkeeper @vinckr
  • pinned discussions on github for /ory org @vinckr
  • banner on website? @jfcurran

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New feature or request.
Projects
None yet
Development

No branches or pull requests

2 participants