-
Notifications
You must be signed in to change notification settings - Fork 3
Docs site improvements #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dominikwilkowski
wants to merge
3
commits into
main
Choose a base branch
from
documentation-site
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 😬 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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