Create a basic docs setup (#128)

Introduce initial documentation template. It resembles how we've approached building docs in other projects like https://github.com/roblox/roact, which has docs hosted at https://roblox.github.io/roact.
Roblox · Jul 6, 2021 · 98322d7 · 98322d7
1 parent 1e4f981
commit 98322d7
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,7 @@
+Closes (ISSUES HERE).
+
+*Put your pull request body here!*
+
+Checklist before submitting:
+* [ ] Added/updated relevant tests
+* [ ] Added/updated documentation
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -0,0 +1,6 @@
+## (Placeholder)
+
+* Document all API members of top-level packages (React/ReactRoblox/ReactIs/???)
+* The vast majority of these should link to external documentation
+* Any members with deviations (e.g. `useState` returning 2 values instead of one array) should noted briefly, and link to a more detailed explanation in the `deviations.md` page if necessary
+
diff --git a/docs/deviations.md b/docs/deviations.md
@@ -1,4 +1,6 @@
 # Deviations
+**This is a work in progress! Most of these notes are old!**
+
 The Roact alignment effort aims to map as closely to React's API as possible, but there are a few places where language deviations require us to omit functionality or deviate our approach.
 
 ## Class Components

diff --git a/docs/extra.css b/docs/extra.css
@@ -0,0 +1,3 @@
+.md-typeset hr {
+	border-bottom: 2px solid rgba(0, 0, 0, 0.15);
+}
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+Roact is a lua port of Facebook's [React](https://reactjs.org) UI library.
+
+This documentation is a work in progress. By and large, documentation on React applies directly to Roact, but deviations in API, behavior, or best practice will be documented here.
diff --git a/docs/migrating-from-roact.md b/docs/migrating-from-roact.md
@@ -0,0 +1,3 @@
+## (Placeholder)
+
+A comprehensive guide for upgrading Roact codebases to be compatible with the Roact 17.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+mkdocs
+mkdocs-material
+pymdown-extensions
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,28 @@
+site_name: Roact Documentation
+site_url: https://roblox.github.io/roact/
+repo_name: Roblox/roact
+repo_url: https://github.com/Roblox/roact
+
+theme:
+  name: material
+  palette:
+    primary: 'indigo'
+    accent: 'indigo'
+    scheme: preference
+
+nav:
+  - Home: index.md
+  - Adoption: migrating-from-roact.md
+  - Deviations: deviations.md
+  - API Reference: api-reference.md
+
+extra_css:
+  - extra.css
+
+markdown_extensions:
+  - admonition
+  - codehilite:
+      guess_lang: false
+  - toc:
+      permalink: true
+  - pymdownx.superfences
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Roact is a lua port of Facebook's [React](https://reactjs.org) UI library.

		This documentation is a work in progress. By and large, documentation on React applies directly to Roact, but deviations in API, behavior, or best practice will be documented here.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## (Placeholder)

		A comprehensive guide for upgrading Roact codebases to be compatible with the Roact 17.