Architecture docs (#386)

* Bootstrapped architecture doc * Added overview and desktop * Added server/client overview * Bootstrapped design system doc * Extended TOC * Desribed client * Added client testing * Added endpoints/models * Merge architecture/design-system * Described stores * Described services * Finished artifacts * Added testing for server * Finished workflows * Finished design system * Added weaknesses * Updated a heading * Added error handling seciton * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Added architecture doc link to the readme * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> * Update portal/content/docs/contributing/architecture.md Co-authored-by: Patricio Del Boca <[email protected]> --------- Co-authored-by: Patricio Del Boca <[email protected]>
okfn · May 20, 2024 · 2f2c893 · 2f2c893
1 parent 16c14fe
commit 2f2c893
Show file tree

Hide file tree

Showing 6 changed files with 361 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -29,6 +29,8 @@ The Open Data Editor (ODE) is a **no-code application** to **explore, validate a
 
 🔵 [Contributing Guide](https://opendataeditor.okfn.org/contributing/development/)
 
+🔵 [Technical Architecture](https://opendataeditor.okfn.org/contributing/architecture/)
+
 # How to download the ODE
 
 📍***Note:** the ODE is currently available for download and testing in beta. We are working on a stable version. Updates will be announced throughout the year.*

diff --git a/portal/astro.config.mjs b/portal/astro.config.mjs
@@ -19,6 +19,7 @@ export default defineConfig({
       },
       favicon: 'favicon.ico',
       customCss: ['typeface-hk-grotesk/index.css', '/assets/styles.css'],
+      tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 5 },
       sidebar: [
         {
           label: 'Documentation',