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

[Documentation] Create First-Time User Guide with Screenshots #33

Open
12mv2 opened this issue Nov 30, 2024 · 0 comments
Open

[Documentation] Create First-Time User Guide with Screenshots #33

12mv2 opened this issue Nov 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers to the project or open source help wanted Extra attention is needed

Comments

@12mv2
Copy link
Collaborator

12mv2 commented Nov 30, 2024

Description

Create a step-by-step guide for first-time users of the Reactive extension. The guide should walk users through installation, initial setup, and first use of the extension, making it easier for new users to get started.

Task Requirements

  1. Create a clear, sequential guide for first-time users
  2. Include screenshots of each major step
  3. Cover installation through first visualization
  4. Use a simple example React project

Steps

  1. Document the installation process:

    • Finding the extension in VS Code marketplace
    • Installation steps
    • Required VS Code settings (if any)
  2. Create screenshots for:

    • Extension installation
    • Extension icon in VS Code sidebar
    • Initial activation
    • First component visualization
    • Basic interaction examples
  3. Write instructions for:

    • How to open/start the extension
    • Selecting the root component
    • Basic navigation of the component tree
    • Common troubleshooting tips
  4. Format everything in clear markdown with:

    • Numbered steps
    • Highlighted commands/buttons
    • Tips and notes where helpful

Resources

Definition of Done

  • Clear, comprehensive guide from installation to first use
  • High-quality screenshots for each major step
  • Proper markdown formatting
  • All images optimized for web
  • Instructions tested by following them on a fresh installation
@12mv2 12mv2 added documentation Improvements or additions to documentation good first issue Good for newcomers to the project or open source help wanted Extra attention is needed labels Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers to the project or open source help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant