summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorMegan Wachs2021-03-18 16:47:58 -0700
committerGitHub2021-03-18 16:47:58 -0700
commitf1ad5b58e8a749d558758288d03ce75bf6b8ff9c (patch)
tree2150d6f41a55f81c9f4cf3b037b715cb75ea617f /docs/README.md
parent2a56c6540e914611ac12647e157aec4c5c595758 (diff)
Reorganize website docs (#1806)
Updates to chisel3 documentation for website: * guard code examples with mdoc and fix errors encountered along the way * move some website content here vs splitting the content across two repos * Bring in the interval-types and loading memories content so that it will be visible from the website * remove all references to the wiki (deprecated) * Remove reference to Wiki from the README * fix tabbing and compile of chisel3-vs-chisel2 section * Appendix: faqs now guarded and compile * FAQs: move to resources section
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md7
1 files changed, 2 insertions, 5 deletions
diff --git a/docs/README.md b/docs/README.md
index dfc7f934..2a34fc45 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -8,8 +8,7 @@ as part of the PR CI checks,
forcing the documentation to remain current with the codebase.
The `src` folder contains the source from which these are generated.
-Previous Wiki documentation, now hosted by the website, is contained in the `src/wiki-deprecated` directory.
-We are in the process of converting this documentation into the four categories as described in
+Our documentation is organized into the four categories as described in
[Divio's documentation system](https://documentation.divio.com/).
The four documentation types are:
@@ -22,9 +21,7 @@ Our documentation strategy for this repository is as follows:
* Any new public API requires reference documentation.
* Any new user-facing feature requires explanation documentation.
* Any bugfixes, corner-cases, or answers to commonly asked questions requires a how-to guide.
- * For now, tutorials are kept in a separate repository. We are working hosting them here.
- * Old documentation is contained in the `src/wiki-deprecated` directory and is being incrementally converted to these
- categories.
+ * Tutorials are kept in a separate repository.
This documentation is hosted on the Chisel [website](https://www.chisel-lang.org).