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

Update Contributing to Docs with information about Quick Start guides #12290

Closed
inventarSarah opened this issue Jan 9, 2025 · 0 comments
Closed

Comments

@inventarSarah
Copy link
Collaborator

Problem Statement

Update "Contributing to docs":

  • inform about differences between a quick start and a getting started guide;
    • why: helps writers decide which guide fits their current documentation goal; provides background information on why we decided to convert the original SDK Getting Started Guides into Quick Start Guides
  • create How to Write - Quick Start guides (or update existing getting started - to be checked)
    • why: provides guidelines, best practices, and templates that help writers create this type of content

Solution Brainstorm

We can do that once we've created a quick start guide for manual installation and one for wizard installation and are happy with the results.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants