WhyDRS is a free educational resource about the financial markets in the United States – specifically direct registration, a method of personal ownership available to everyone but rarely used. Keeping long investments in your own name - with the SEC approved Direct Registration System - provides multiple benefits and safeties not available through other means.
Quick Start
Prerequisites
To begin development on the documentation, you will first need to install the following:
- Node.js (v19, not higher): see https://nodejs.org/en/download/package-manager for details for your system
- npm: e.g.
sudo apt install npmon Ubuntu - yarn:
npm install yarn
Development
Once all the prerequisites have been installed, you can run the following commands:
git clone https://github.com/whydrs/dao-docs
cd dao-docs
yarn install
npx docusaurus startThis will begin the development server, and open a browser window/tab pointing
to http://localhost:3000/docs/. This development server will auto-reload when
it detects changes to the repository.
After you've made your changes, use the following commands to ensure the consistent MDX file formatting and style across the repository:
npm run check:mdx # this will search for problems in the MDX files
npm run format:mdx # this will fix any problems that were foundRepository Structure
/docs/Contains all the documentation content./comments/Contains crowdsourced regulatory comments./peitions/Contains crowdsourced regulatory petitions./blog/Contains community contributor posts./src/Contains non-documentation code files./static/Contains static assets like images.[^static]
[^static]: Anything in this directory will be copied to the root of the final build directory.
Using Markdown
Markdown Basics
If you're unfamiliar with Markdown, there are loads of good tutorials and cheat sheets out there. Check out some of these resources to get a handle on the basics: