Skip to content

Commit b911b91

Browse files
darthezMaciej Rys
andauthored
docs: added seo optimization (#142)
## Description <!-- Provide a concise and descriptive summary of the changes implemented in this PR. --> ### Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] Documentation update (improves or adds clarity to existing documentation) ### Tested on - [ ] iOS - [ ] Android ### Testing instructions <!-- Provide step-by-step instructions on how to test your changes. Include setup details if necessary. --> ### Screenshots <!-- Add screenshots here, if applicable --> ### Related issues <!-- Link related issues here using #issue-number --> ### Checklist - [x] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [x] I have updated the documentation accordingly - [x] My changes generate no new warnings ### Additional notes <!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. --> Co-authored-by: Maciej Rys <maciej.rys@swmansioncom>
1 parent 5d28987 commit b911b91

File tree

8 files changed

+66
-0
lines changed

8 files changed

+66
-0
lines changed

docs/docs/fundamentals/getting-started.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
11
---
22
title: Getting Started
33
sidebar_position: 1
4+
keywords:
5+
[
6+
react native,
7+
executorch,
8+
ai,
9+
machine learning,
10+
on-device,
11+
pytorch,
12+
mobile ai,
13+
getting started,
14+
installation,
15+
llm,
16+
]
17+
description: 'Get started with React Native ExecuTorch - a framework for running AI models on-device in your React Native applications.'
418
---
519

620
import Tabs from '@theme/Tabs';

docs/docs/llms/useLLM.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
11
---
22
title: useLLM
33
sidebar_position: 1
4+
keywords:
5+
[
6+
llm,
7+
large language model,
8+
llama,
9+
llama 3,
10+
react native,
11+
executorch,
12+
ai,
13+
machine learning,
14+
on-device,
15+
mobile ai,
16+
inference,
17+
text generation,
18+
]
19+
description: "Learn how to use Llama models in your React Native applications with React Native ExecuTorch's useLLM hook."
420
---
521

622
React Native ExecuTorch supports Llama 3.2 models, including quantized versions. Before getting started, you’ll need to obtain the .pte binary—a serialized model—and the tokenizer. There are various ways to accomplish this:

docs/docs/speech-to-text/useSpeechToText.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
11
---
22
title: useSpeechToText
33
sidebar_position: 1
4+
keywords:
5+
[
6+
speech to text,
7+
stt,
8+
voice recognition,
9+
transcription,
10+
whisper,
11+
moonshine,
12+
react native,
13+
executorch,
14+
ai,
15+
machine learning,
16+
on-device,
17+
mobile ai,
18+
]
19+
description: "Learn how to use speech-to-text models in your React Native applications with React Native ExecuTorch's useSpeechToText hook."
420
---
521

622
With the latest `v0.3.0` release we introduce a new hook - `useSpeechToText`. Speech to text is a task that allows to transform spoken language to written text. It is commonly used to implement features such as transcription or voice assistants. As of now, [all supported STT models](#supported-models) run on the XNNPACK backend.

docs/docusaurus.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ const darkCodeTheme = require('./src/theme/CodeBlock/highlighting-dark.js');
44
/** @type {import('@docusaurus/types').Config} */
55
const config = {
66
title: 'React Native ExecuTorch',
7+
tagline:
8+
'Declarative way to run AI models in React Native on device, powered by ExecuTorch',
79
favicon: 'img/favicon.ico',
810

911
url: 'https://docs.swmansion.com',
@@ -35,6 +37,12 @@ const config = {
3537
trackingID: 'G-TJND8QJM9P',
3638
anonymizeIP: true,
3739
},
40+
sitemap: {
41+
changefreq: 'weekly',
42+
priority: 0.5,
43+
ignorePatterns: ['/tags/**'],
44+
filename: 'sitemap.xml',
45+
},
3846
}),
3947
],
4048
],

docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
},
1717
"dependencies": {
1818
"@docusaurus/core": "2.4.3",
19+
"@docusaurus/plugin-sitemap": "2.4.3",
1920
"@docusaurus/preset-classic": "2.4.3",
2021
"@mdx-js/react": "^1.6.22",
2122
"@swmansion/t-rex-ui": "^0.0.14",

docs/src/pages/index.tsx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import React from 'react';
22
import Layout from '@theme/Layout';
3+
import Head from '@docusaurus/Head';
34
import styles from './styles.module.css';
45
import HomepageStartScreen from '@site/src/components/Hero/StartScreen';
56
import WaveTop from '@site/src/components/Wave/WaveTop';
@@ -14,6 +15,12 @@ const Home = () => {
1415
title="React Native ExecuTorch"
1516
description="Declarative way to run AI models in React Native on device, powered by ExecuTorch."
1617
>
18+
<Head>
19+
<meta
20+
name="keywords"
21+
content="react native, executorch, ai, machine learning, on-device, pytorch, mobile ai, react native ai, artificial intelligence, mobile machine learning, on-device inference, llama, llm, whisper, ocr, moonshine, speech to text"
22+
/>
23+
</Head>
1724
<div className={styles.container}>
1825
<HomepageStartScreen />
1926
</div>

docs/static/robots.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
User-agent: *
2+
Allow: /
3+
Sitemap: https://docs.swmansion.com/react-native-executorch/sitemap.xml

docs/yarn.lock

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4739,6 +4739,7 @@ __metadata:
47394739
dependencies:
47404740
"@docusaurus/core": 2.4.3
47414741
"@docusaurus/module-type-aliases": 2.4.3
4742+
"@docusaurus/plugin-sitemap": 2.4.3
47424743
"@docusaurus/preset-classic": 2.4.3
47434744
"@mdx-js/react": ^1.6.22
47444745
"@swmansion/t-rex-ui": ^0.0.14

0 commit comments

Comments
 (0)