Skip to content
Open
Changes from 2 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
25 changes: 25 additions & 0 deletions RFC-by-stage/1-approved/docs-site.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
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

Prior art here: https://github.com/dominikwilkowski/ds-workshop

MORE DETAILS COMING 😬

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eleventy could be a good option here, they support vanilla + React, that would work with the design.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to first and foremost support no-js in the docs and eleventy no matter how hip it currently is will not allow us to do this. I think the best course of action here is to use nextjs and export it to static HTML and CSS