Docs are outdated

[chrisrzhou]

The docs are currently not fully describing the APIs seen in unified-doc@v1.0.0 and unified-doc-react@v1.0.0. Please refer to the project repos for documentation in the meantime.

I've been extremely busy the past month with work :( I will be updating this repo in the upcoming weeks so I apologize in advance for any inconveniences/confusion!

Note: an ambitious goal is to generate the docs by crawling documentation files in this repo and rendering them with unified-doc! I'll probably approach it this way and integrate a crawl pipeline with the current docz/gatsby site. See unified-doc/ideas#1 for an idea how this could be done through a CLI in the future!

[chrisrzhou]

cc @downtownbrown19 since you have asked about updates on documentation. A quick expectation in the upcoming weeks:

• Implement and ship unified-doc-dom package.
• Do a quick update to docs to keep documentation up-to-date.
• Setup branching strategy so users can refer to previous branch documentation if they rely on an older implementation of the project.

At this point, the docs should be meaningfully updated, and a more ambitious goal after this is to work on:

• unified-doc-cli
• Update the docs build pipeline to be processed/prepared using unified-doc-cli.