Dev-Docs Quickstart
See Dev-Docs in action! The quickstart requires that you have an account. If you haven't made one yet, see Create an Account and Org. If you have then you're ready to go!
To get started open our hello world repo that has a sample dev-docs.json file already configured.
Open and Run in GitHub Codespaces
Once open follow these steps.
Get Dev-Docs Extension Setup
Step 1: Install the Extension
Search Dev-Docs and then click install.
Step 2: Sign into Dev-Docs in VS Code
Click on the Dev-Docs extension button in your Github Codespace or VS Code Editor. Select sign in and then follow the steps to select the org you created when you set up your account.
Create Onboarding Docs on a codefile
Step 1: Open the index.js file
Click on the index.js file to open it.
Step 2: Generate Documentation
Right click on index.js and find the dev-docs submenu and click generate documentation.
Step 3: Wait and Open your documentation on Your Codefile
Wait for the documentation to generate, and then right click to open the context menu and click Open Dev-doc for current file. And you are done with Internal Documentation
Generate Public Documentation Site
Step 1: Click on the 'dev-docs: Populate External Docs' option to generate Public SDK Documentation
Open the command palette with shift cmd P, and find/click on the 'dev-docs: Populate External Docs' option.
How it works
This codebase has the dev-docs.json in this repo is preconfigured to filter out specific aspects of the codebase to documentation as well as custom options to augment/customize the documentation
