Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions RFC-by-stage/1-approved/docs-site.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
Status: `Proposal` # Please do not change this.
Implementer: # It will be changed upon merging and as it moves through the RFC stages
---

# Build a simpler docs site

## The issue to be solved

The current docs site, while static and well designed, is outdated and not driven with the same pace as the components.
Co-location of docs and components will also solve the issue of features that are being developed having to include docs (changes) in the same piece of work making the definition of done more transparent.
Another issue is that the current tool is too niche and it's hard to use. We should use something as simple as possible to be able to focus on the content.
We need to retain the static nature of the docs site so we can continue to rely on free static hosting like GitHub pages or Netlify etc.
the information of the pages are also outdated not that the components have moved into the Design System Au group.

## A short description of the solution

We should co-locate the docs site into the same repo as the components and drive the documentation of each component from a docs file that sites in the same folder as the component itself. Preferably a README.md file that can be digested by the docs site.
We should strip other irrelevant pages from the site as well and perhaps add pages describing this groups efforts.

## Technical details

Implementation: https://github.com/dominikwilkowski/ds-workshop

The docs site will be inside the monorepo so we will be able to re-use the docs for each component from each component folder.
The design will simplify a bit to keep it simple.
I propose [next.js](https://nextjs.org/) to build the site off of it's own react components.
We will then use the [`export`](https://nextjs.org/docs/advanced-features/static-html-export) task of next to generate flat static html pages.
That way the page will work without js.