Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

Rewrote the docs structure. #509

Merged

Conversation

matvp91
Copy link
Contributor

@matvp91 matvp91 commented May 22, 2020

I've cleaned up the structure of the docs in order to better match a single page.

image

@EduardoLopes EduardoLopes requested a review from sebmck May 22, 2020 18:36
@sebmck
Copy link
Contributor

sebmck commented May 22, 2020

I think we'll want to remove the manual cloning/build instructions. It's confused a lot of people. We should keep some of that only in the contributing docs. We actually already have a release published to npm under rome 🤐

@sebmck
Copy link
Contributor

sebmck commented May 22, 2020

(That's just a general unrelated criticism of the current docs, your changes look great!)


Rome is not available via `npm` and must be installed from GitHub.
In a folder of your choice, clone the `rome` repository:
Rome is currently not available via `npm`, and must be installed from GitHub. In a folder of your choice, clone the `rome` repository.
Copy link
Contributor

Choose a reason for hiding this comment

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

Rome technically is available through npm with yarn add rome@^0.0.25 or npm install rome@^0.0.25. Not sure if its premature to add it in the docs though. Either way, I thought I'd point that out.

@matvp91
Copy link
Contributor Author

matvp91 commented May 22, 2020

Most of the documentation in this PR is straight out ported from the Docusaurus build, with the difference that the headings should better fit the single page structure.

Due to us moving to this format, the sidebar became a whole lot more important.

@sebmck I'll rewrite the Installation part once I gave it a spin through npm. Although, I'm not sure if it's too early to push people to npm.

The final result ends up here: #507

website/src/docs/Linting.md Outdated Show resolved Hide resolved
@matvp91 matvp91 mentioned this pull request May 22, 2020
3 tasks
@EduardoLopes EduardoLopes merged commit 9255e80 into rome:EduardoLopes/new-website May 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants