This repository was archived by the owner on Aug 31, 2023. It is now read-only.
chore: Re-structure Website #3466
Merged
Conversation
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
✅ Deploy Preview for rometools ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
c28019a to
0b9bd56
Compare
This PR restructures our Website by: * Removing the dead careers link * Moving the API documentation into the footer * Splitting out a new `Docs` page (inspired by Tailwind, Parcel, Eslint, ...) Improving the layout by * Using the `--primary-color` for the active link in the TOC * Using `font-weight: bold` for the main titles in the TOC The PR includes some fixes: * Enable the TOC for blog posts (requires change the header to `h2` and adding an id. * Add the `DESCRIPTION_END` marker to only render the header of the rome formatter release blog post in the overview I further made some improvements to the content. ## Long term I think we want to move to a multi-page documentation where we have a page per section. This gives us more layouting option (and e.g. allows to directly link to the lint rules in the docs TOC). However, I don't know how to easily achieve this with our current website.
0b9bd56 to
6d2bff3
Compare
|
I can see that the "Getting Started" section is repeated in the home page and the "Docs" page. Is it intentional? |
ematipico
approved these changes
Oct 21, 2022
Yes it's intentional but ideally, it shouldn't. The way I envision it is to have a short intro at the top of the page that has a call to action button "Get started". But that requires new content for the start page that I don't have right now. Do you know of a "minimum effort" way I could accomplish the same without repeating? |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR restructures our Website by:
Docspage (inspired by Tailwind, Parcel, Eslint, ...)Improving the layout by
--primary-color--primary-colorin dark mode and thecolor3in light mode for the active link in the TOC.--primary-colordoesn't work in the light mode because it has too little contrast.font-weight: boldfor the main titles in the TOCThe PR includes some fixes:
h2and adding an id.DESCRIPTION_ENDmarker to only render the header of the rome formatter release blog post in the overviewI further made some improvements to the content.
Long term
I think we want to move to a multi-page documentation where we have a page per section. This gives us more layouting option (and e.g. allows to directly link to the lint rules in the docs TOC). However, I don't know how to achieve this with our current website easily.