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

v2.6 Docs #63

Closed
5 tasks
kalambet opened this issue Oct 13, 2023 · 2 comments · Fixed by #121
Closed
5 tasks

v2.6 Docs #63

kalambet opened this issue Oct 13, 2023 · 2 comments · Fixed by #121
Assignees

Comments

@kalambet
Copy link
Member

kalambet commented Oct 13, 2023

Epic about all the issues related to Docs up to v2.6, namely:

  • Create and QA for all documents for version 2.5.x
  • Quality assurance done based on
    • Docs Coverage
    • Proof-reading (Development & Marketing)
    • Developer Feedback

CS Gaming SDK Docs v2.6

Quality: We aim to provide comprehensive, accurate, and up-to-date documentation. It should be easy to understand and follow, with:

  • clear explanations
  • up-to-date code examples
  • troubleshooting guidance

Maintaining high-quality documentation ensures developers can rely on it as a valuable resource throughout their project development.

Marketing Goals: Our documentation should serve as a technical resource and a marketing tool. It should:

  • showcase our SDK's capabilities
  • promote our unique features
  • highlight the value proposition to developers.

By presenting our SDK appealingly and compellingly, we aim to attract developers and encourage them to choose our solution over competitors.

Pedagogy: Our documentation should follow sound pedagogical principles to facilitate learning and skill development. We want developers to be captivated by our documentation from the moment they first encounter it, feeling confident and motivated to explore our SDK.

We strive to provide a clear learning path, gradually guiding developers from primary usage to advanced topics.

Ultimately, we aim to empower developers to become core contributors to our project, fostering a sense of ownership and engagement.

Roadmap Q4 2023

image

@boorich
Copy link
Member

boorich commented Oct 13, 2023

@kalambet This epic needs to become part of the game docs v2 repo as discussed.

@kalambet kalambet transferred this issue from ChainSafe/web3.unity Oct 13, 2023
@kalambet
Copy link
Member Author

done!

@boorich boorich self-assigned this Oct 19, 2023
@sneakzttv sneakzttv changed the title v2.5 Docs v2.6 Docs Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants