From 3bff9f9e7a05e58c85e6fc8d8de4d0da03ead3e1 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Tue, 30 Jul 2024 18:19:50 -0700 Subject: [PATCH] docs - feedback from zim --- docs/README.md | 3 ++- docs/docusaurus.config.js | 10 +++------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/README.md b/docs/README.md index 284f5b60c..5c6adca84 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) @@ -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. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index babdd43e0..9452d0eea 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -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 // pathname under which your site is served - // For GitHub pages deployment, it is often '//' 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', @@ -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', },