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

ADR-0004: Move/update GettingStarted.md content #223

Open
8 tasks
bderusha opened this issue Dec 15, 2022 · 1 comment
Open
8 tasks

ADR-0004: Move/update GettingStarted.md content #223

bderusha opened this issue Dec 15, 2022 · 1 comment

Comments

@bderusha
Copy link

bderusha commented Dec 15, 2022

User Story

As a carbon aware sdk user, I want all relevant docs to exist in the /docs directory, per the standard set by ADR-0004, so I can have consistent expectations about where to go for content.

Design Goals

  • Find a home for all existing GettingStarted.md content.
  • Understand the difference between GettingStarted and quickstart and make it clearer (or merge if no difference).
  • Markdown-lint compliant

Task List

  • Moving GettingStarted.md (GS) into docs
  • Review GS and quickstart.md (QS) and identify similarities/overlap in content
  • Decide whether GS ans QS should be merged into a single doc or own different spheres (idea: one is architecture focused; one code focused....)
  • Leverage outcome ^^ to also help guide new users on navigating other documentation

Acceptance Criteria

  • GettingStarted.md no longer exists in the root directory
  • User have a clear guide for starting out with the SDK
  • All unique pieces of information from the original GettingStarted.md can be found somewhere in /docs
  • Content touched is markdown-lint compliant
@bderusha bderusha changed the title ADR-0004: Move/update GettingStarted.md ADR-0004: Move/update GettingStarted.md content Dec 15, 2022
@JenMadiedo
Copy link

@Kpopovs1 taking point, with @JenMadiedo. Will circle back with @in4margaret when she returns.

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

No branches or pull requests

5 participants