docs: updated installation instructions and began organizing the headers for the doc site #56
Conversation
Jazmin915
commented
Apr 21, 2024
Jazmin915
commented
- Added 'community' to the nav bar and linked it to the discord server.
- I began adding the react-native-mediapipe installation steps and descriptions to the intro.md page.
- Made a slight change to the sidebar by changing the title names of the pages
…ers for the doc site
docsite/docs/intro.md
Outdated
| ```bash | ||
| module.exports = { | ||
| presets: ['module:@react-native/babel-preset'], | ||
| plugins: [['react-native-workless-core/plugin']], |
docsite/docusaurus.config.ts
Outdated
| @@ -86,6 +92,15 @@ const config: Config = { | |||
| }, | |||
| ], | |||
| }, | |||
| { | |||
There was a problem hiding this comment.
this adds another footer section titled Community with a single broken link to a page that doesn't exist. What are you trying to achieve with this?
docsite/docusaurus.config.ts
Outdated
| to: '/docs/community', | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| title: 'Community', | ||
| items: [ |
There was a problem hiding this comment.
Given that this link doesn't actually work (because I didn't realize I needed a particular invite link) - just remove this and the section ? Or fix the link in here to be the same as in the header ? Or not add the one in the header at all and only here ? Also, any additional items we want to throw under the title "Community" we should put in the items collection, and not add any other sections titled Community, that's just confusing. Typically, you'd put discord/twitter/whatever else you got here.
Also, this will FAIL building the documentation site because the build realizes it's a broken link. Run "yarn build" and observe this failure:
[ERROR] Error: Unable to build website for locale en.
at tryToBuildLocale (/Users/robertorleth/Documents/Github/react-native-mediapipe/docsite/node_modules/@docusaurus/core/lib/commands/build.js:53:19)
at async /Users/robertorleth/Documents/Github/react-native-mediapipe/docsite/node_modules/@docusaurus/core/lib/commands/build.js:64:9
at async mapAsyncSequential (/Users/robertorleth/Documents/Github/react-native-mediapipe/docsite/node_modules/@docusaurus/utils/lib/jsUtils.js:20:24)
at async Command.build (/Users/robertorleth/Documents/Github/react-native-mediapipe/docsite/node_modules/@docusaurus/core/lib/commands/build.js:62:5) {
[cause]: Error: Docusaurus found broken links!
Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
It looks like some of the broken links we found appear in many pages of your site.
Maybe those broken links appear on all pages through your site layout?
We recommend that you check your theme configuration for such links (particularly, theme navbar and footer).
Frequent broken links are linking to:
- /react-native-mediapipe/docs/community
There was a problem hiding this comment.
I'm trying to make the changes for the community link and had a couple of questions. I have removed the extra community from the footer and inserted a invite link to the community that was there before. If someone were to click on it, it takes them to our discord but it says that I am personally inviting them so it shows my name and user. Not sure if there is a better link we should be using. Also, you mentioned not having the community in the header at all or making sure both communities (from header and footer) are the same. Which would you suggest is the better option?
There was a problem hiding this comment.
I don't know that my opinion here is totally relevant, but if you put yourself in the shoes of a person coming to read this page - would you expect to have two links to the same spot, or would that confuse you ? I think a person looking for a Discord link should find it.
No idea about your first question, with making the invite link not personal to you. Looks like this one works (may require a paid account though ?): https://support.discord.com/hc/en-us/articles/115001542132-Custom-Invite-Link
There was a problem hiding this comment.
I removed the community from the nav bar and decided to just keep the one in the footer. I also changed the link for the discord to never expire.
docsite/docs/intro.md
Outdated
| </p> | ||
| <pre> | ||
| <code> | ||
| <key>NSCameraUsageDescription</key> |
There was a problem hiding this comment.
No need to hand-encode those, just put the triple ticks before and after, like you do with other code types
