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

Docs: refactor structure of documentation #479

Closed
IceKhan13 opened this issue May 1, 2023 · 0 comments · Fixed by #481
Closed

Docs: refactor structure of documentation #479

IceKhan13 opened this issue May 1, 2023 · 0 comments · Fixed by #481
Assignees
Labels
documentation Improvements or additions to documentation epic For epics and projects priority: medium Medium priority
Milestone

Comments

@IceKhan13
Copy link
Member

IceKhan13 commented May 1, 2023

What is the expected enhancement?

Feedback:

  • to dev focused
  • have a structure as a story that users can follow along
  • remove duplication
  • focus on main features on main page

New proposed structure:
Main page:

  • picture
  • what is serverless and why do researcher needs it
  • cover core concepts

General structure:

  • quickstart
  • setup
  • running
  • concepts
    • programming model
    • compute resources and resource allocation
  • tutorials
    • VQE
    • distributed transpilation
  • troubleshooting

Issues in epic:

@IceKhan13 IceKhan13 added documentation Improvements or additions to documentation epic For epics and projects priority: medium Medium priority labels May 1, 2023
@IceKhan13 IceKhan13 added this to the 0.1 milestone May 1, 2023
@IceKhan13 IceKhan13 self-assigned this May 1, 2023
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 epic For epics and projects priority: medium Medium priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant