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

doc(review)athon #244

Closed
62 tasks done
egamma opened this issue Mar 23, 2016 · 1 comment
Closed
62 tasks done

doc(review)athon #244

egamma opened this issue Mar 23, 2016 · 1 comment
Milestone

Comments

@egamma
Copy link
Member

egamma commented Mar 23, 2016

Goals

  • check the doc for accuracy
  • add missing tips
  • add new contents if appropriate

Guidelines from @gregvanl

  • Update the docs in vscode-docs vnext branch.
    • You can commit directly and don’t need to create pull requests.
    • You can be pretty fast and loose and I’ll follow up with an extensive edit and formatting pass afterwards.
  • Write the content targeting the March release.
    • For walkthrough flow, use the new features available in 0.10.12 (e.g. jsconfig.json creation, tasks.json dropdown, jsconfig.json autoload,etc).
    • Focus on likely user scenarios and workflows. Corner cases or less used features can be called out in the Common Questions section at the end.
    • If you find that you are adding a lot of Tips and Tricks which interrupts a topic’s flow, consider adding a Tips and Tricks section at the bottom of the topic.
  • Try to use separate commits for separate changes and docs.
    • This will make it easier to cherry pick commits that we want to move to master before we merge vnext at the 1.0 release.

Coverage

Editor

Customization

Languages

Runtimes

Extensions

Extensbility Reference

Tools

@egamma egamma added this to the March 2016 milestone Mar 23, 2016
@gregvanl
Copy link

Boxes all checked.

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

No branches or pull requests

2 participants