diff --git a/README.md b/README.md index f445f0c..df5c792 100644 --- a/README.md +++ b/README.md @@ -26,15 +26,15 @@ gem 'ransack' ### Bleeding edge -If you would like to use the latest updates not yet published to RubyGems, use the `master` branch: +If you would like to use the latest updates not yet published to RubyGems, use the `main` branch: ```jsx title='Gemfile' -gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'master' +gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'main' ``` ### Documentation -There is extensive documentation on Ransack, which is a [Docusaurus](https://docusaurus.io/) project and run as a GitHub Pages site. +There is [extensive documentation on Ransack](https://activerecord-hackery.github.io/ransack/), which is a [Docusaurus](https://docusaurus.io/) project and run as a GitHub Pages site. ## Issues tracker diff --git a/docs-website/docs/going-further/documentation.md b/docs-website/docs/going-further/documentation.md index 6e953c1..c44cfce 100644 --- a/docs-website/docs/going-further/documentation.md +++ b/docs-website/docs/going-further/documentation.md @@ -13,3 +13,19 @@ Make sure you have `npm` installed, then: cd docs-website npm run start ``` + +### Build + +Build the assets before commiting changes. + +``` +cd docs-website +npm run build +``` + +### Test locally + +``` +cd docs-website +npm run serve +``` diff --git a/docs-website/docusaurus.config.js b/docs-website/docusaurus.config.js index 9fdc280..e755448 100644 --- a/docs-website/docusaurus.config.js +++ b/docs-website/docusaurus.config.js @@ -15,6 +15,7 @@ const config = { favicon: 'img/favicon.ico', organizationName: 'activerecord-hackery', projectName: 'ransack', + trailingSlash: false, presets: [ [ @@ -69,7 +70,7 @@ const config = { items: [ { label: 'Documentation', - to: '/docs/intro', + to: '/', }, ], },