Skip to content

Commit

Permalink
docs - feedback from zim
Browse files Browse the repository at this point in the history
  • Loading branch information
lukegalbraithrussell committed Jul 31, 2024
1 parent 69bc124 commit 3bff9f9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ The following command starts a local development server and opens up a browser w

```
npm run start
open http://localhost:3000/bolt-python/getting-started # visit a page
```

Edits to pages are reflected live — no restarting the server or reloading the page. (I'd say... 95% of the time, and 100% time if you're just editing a markdown file)
Expand All @@ -88,7 +89,7 @@ Remember — you're only viewing the Bolt-JS docs right now.
For local runs, Docusaurus treats each language as a different instance of the website. You'll want to specify the language to run the japanese site locally:

```
npm run start -- --locale ja
npm run start -- --locale ja-jp
```

Don't worry - both languages will be built/served on deployment.
Expand Down
10 changes: 3 additions & 7 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,10 @@ const config = {
tagline: 'Official frameworks, libraries, and SDKs for Slack developers',
favicon: 'img/favicon.ico',

// Set the production url of your site here
url: 'https://slack.dev',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/bolt-js/',
// GitHub pages deployment config.
organizationName: 'slackapi', // Usually your GitHub org/user name.
projectName: 'bolt-js', // Usually your repo name.
organizationName: 'slackapi',
projectName: 'bolt-js',

onBrokenLinks: 'warn',
onBrokenAnchors: 'warn',
Expand Down Expand Up @@ -162,7 +158,7 @@ const config = {
{
'aria-label': 'GitHub Repository',
'className': 'navbar-github-link',
'href': 'https://github.com/slackapi',
'href': 'https://github.com/slackapi/bolt-js',
'position': 'right',
target: '_self',
},
Expand Down

0 comments on commit 3bff9f9

Please sign in to comment.