Skip to content

Latest commit

 

History

History
 
 

docs

RedwoodJS Docs

Deployment URL: https://redwoodjs.com/docs

Getting started

Checkout this repo (redwoodjs/redwood), cd into this directory (docs)

yarn install

yarn start

Making Changes

Changes should be made in the ./docs directory and not in the generated ./versioned_docs or ./versioned_sidebars directories directly.

After running yarn start, you should be able to see your changes in the local Canary Version.

Internal linking

For links to other docs inside the tutorials directory you need to use relative links.

In [previous section](./first-page) we....

Contributing

Fork the repo, make your changes and open a PR on GitHub. That will build and launch a copy of the site that you can get from the netlify/redwoodjs/deploy-preview check (click "Details" to open it):

image

Double check that your changes look good!

Updating Doc Images

To update any images in the doc, first upload your screenshot into a comment textbox in your PR. Once it's uploaded, you can open the image in a new tab and use the github url as a image link in your docs.

Contributors

Redwood is amazing thanks to a wonderful community of contributors.