chore: archive of api docs

sgammon · sgammon · commit a0735aea8bb1 · 2024-05-15T19:48:18.000-07:00
Signed-off-by: Sam Gammon &lt;sam@elide.ventures&gt;
diff --git a/API/1.0.0-alpha9.tgz b/API/1.0.0-alpha9.tgz
diff --git a/API/README.md b/API/README.md
@@ -0,0 +1,8 @@
+# API Documentation
+
+The latest API docs from the main [Elide repo](https://github.com/elide-dev/elide) are archived here, so they may be built with the docs site, and included in the output that is uploaded to hosting.
+
+## Contributing to the API Docs
+
+The API docs are built automatically with [Dokka](https://github.com/Kotlin/dokka/). See the main Elide repo for directions to build the API docs.
+
diff --git a/API/latest.tgz b/API/latest.tgz
@@ -0,0 +1 @@
+1.0.0-alpha9.tgz
diff --git a/README.md b/README.md
@@ -13,10 +13,11 @@ Documentation structure is described using a combination of XML and Markdown; XM
 hierarchy, and Markdown/[MDX](https://mdxjs.com/) is used to describe actual content. This project focuses on
 **narrative documentation**, where Dokka focuses on API docs, and Knit focuses on code samples.
 
-This codebase includes docs from [`elide-dev/elide`](https://github.com/elide-dev/elide) through
-[Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). Elide is pinned at a particular commit hash, and
-then docs are consumed and included via Writerside and Gradle.
+### API Docs
+
+API documentation is generated for each release of Elide, and included as an archive in the [API directory](./API). This content is merged with the main doc site content on-build, and it is published in unison.
 
 ## Contributing
 
-There isn't a contributor guide yet, but you can get started by cloning the repo and opening it in Writerside.
+There isn't a contributor guide yet, but you can get started by cloning the repo and opening it in Writerside. You can also refer to the contributor guide in the main [Elide repo](https://github.com/elide-dev/elide).
+
