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.

Sign up for GitHub

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

Jump to bottom

Improve readme and docs #217

Closed
IceKhan13 opened this issue Feb 17, 2023 · 0 comments · Fixed by #222
Closed

Improve readme and docs #217

IceKhan13 opened this issue Feb 17, 2023 · 0 comments · Fixed by #222
Assignees
@IceKhan13
Labels
documentation Improvements or additions to documentation priority: high High priority
Milestone
0.1

Comments

@IceKhan13
Copy link
Member

IceKhan13 commented Feb 17, 2023 •
edited
Loading

What is the expected enhancement?

Feedback from latest conversations

Improve readme by:

  • creating introduction or about section which explains what serverless is and what is it for
  • simplify example in readme. Example should have simple hello world program without states, parallel execution etc.
  • create 3 levels of examples: beginner as readme, intermediate (install packages, use state), advanced (use distributed computation graphs)
  • add future roadmap
@IceKhan13 IceKhan13 added documentation Improvements or additions to documentation priority: high High priority labels Feb 17, 2023
@IceKhan13 IceKhan13 added this to the 0.1 milestone Feb 17, 2023
@IceKhan13 IceKhan13 self-assigned this Feb 20, 2023
@IceKhan13 IceKhan13 mentioned this issue Feb 20, 2023
Merged
@Tansito Tansito changed the title Docs: improve readme and docs Improve readme and docs Mar 15, 2023
akihikokuroda pushed a commit that referenced this issue Aug 22, 2024
@Tansito
Merge pull request #217 from IBM-Q-Software/middleware-domain
9d240a8 
Add Middleware domain to backstage
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@IceKhan13 IceKhan13

Labels
documentation Improvements or additions to documentation priority: high High priority
Projects
None yet
Milestone
0.1
Development

Successfully merging a pull request may close this issue.

Issue 217 | Docs: getting started 3 level tutorials Qiskit/qiskit-serverless
1 participant
@IceKhan13