Skip to content

Commit

Permalink
Docs/fix docs links (#534)
Browse files Browse the repository at this point in the history
  • Loading branch information
micheleriva authored Oct 29, 2023
1 parent 1b89033 commit 6dfef9d
Show file tree
Hide file tree
Showing 10 changed files with 53 additions and 52 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ the
- [Fields Boosting](https://docs.oramasearch.com/open-source/usage/search/fields-boosting)
- [Typo tolerance](https://docs.oramasearch.com/open-source/usage/search/introduction#typo-tolerance)
- [Exact match](https://docs.oramasearch.com/open-source/usage/search/introduction#exact-match)
- [Stemming and tokenization in 28 languages](https://docs.oramasearch.com/text-analysis/stemming)
- [Stemming and tokenization in 28 languages](https://docs.oramasearch.com/open-source/text-analysis/stemming)

# Installation

Expand Down
87 changes: 44 additions & 43 deletions packages/docs/public/sitemap-0.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/orama/src/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const errors = {
NO_LANGUAGE_WITH_CUSTOM_TOKENIZER: 'Do not pass the language option to create when using a custom tokenizer.',
LANGUAGE_NOT_SUPPORTED: `Language "%s" is not supported.\nSupported languages are:\n - ${allLanguages}`,
INVALID_STEMMER_FUNCTION_TYPE: `config.stemmer property must be a function.`,
MISSING_STEMMER: `As of version 1.0.0 @orama/orama does not ship non English stemmers by default. To solve this, please explicitly import and specify the "%s" stemmer from the package @orama/stemmers. See https://docs.oramasearch.com/text-analysis/stemming for more information.`,
MISSING_STEMMER: `As of version 1.0.0 @orama/orama does not ship non English stemmers by default. To solve this, please explicitly import and specify the "%s" stemmer from the package @orama/stemmers. See https://docs.oramasearch.com/open-source/text-analysis/stemming for more information.`,
CUSTOM_STOP_WORDS_MUST_BE_FUNCTION_OR_ARRAY: 'Custom stop words array must only contain strings.',
UNSUPPORTED_COMPONENT: `Unsupported component "%s".`,
COMPONENT_MUST_BE_FUNCTION: `The component "%s" must be a function.`,
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-data-persistence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This plugin aims to provide data persistence capabilities to Orama.

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/plugins/plugin-data-persistence).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-data-persistence).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-data-persistence/src/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ export function FILESYSTEM_NOT_SUPPORTED_ON_RUNTIME(runtime: string): string {
}

export function METHOD_MOVED(method: string): string {
return `Function ${method} has been moved to the "/server" module. \n\nImport it via "import { ${method} } from 'orama/plugin-data-persistence/server'". \n\nRead more at https://docs.oramasearch.com/plugins/plugin-data-persistence.`
return `Function ${method} has been moved to the "/server" module. \n\nImport it via "import { ${method} } from 'orama/plugin-data-persistence/server'". \n\nRead more at https://docs.oramasearch.com/open-source/plugins/plugin-data-persistence.`
}
2 changes: 1 addition & 1 deletion packages/plugin-match-highlight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This plugin aims to provide a match location for search results.

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/plugins/plugin-match-highlight).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-match-highlight).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-nextra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Official plugin to provide search capabilities through Orama on any Nextra websi

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/plugins/plugin-nextra).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-nextra).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-parsedoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This plugin aims to generate an index for Orama from HTML files

# Usage

For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/plugins/plugin-parsedoc).
For the complete usage guide, please refer to the [official plugin documentation](https://docs.oramasearch.com/open-source/plugins/plugin-parsedoc).

# License

Expand Down
2 changes: 1 addition & 1 deletion packages/stemmers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const db = create({
})
```
Read more in the official docs: [https://docs.oramasearch.com/text-analysis/stemming](https://docs.oramasearch.com/text-analysis/stemming).
Read more in the official docs: [https://docs.oramasearch.com/open-source/text-analysis/stemming](https://docs.oramasearch.com/open-source/text-analysis/stemming).
# License
Expand Down
2 changes: 1 addition & 1 deletion packages/stopwords/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ const db = create({
})
```
Read more in the official docs: [https://docs.oramasearch.com/text-analysis/stop-words](https://docs.oramasearch.com/text-analysis/stop-words).
Read more in the official docs: [https://docs.oramasearch.com/open-source/text-analysis/stop-words](https://docs.oramasearch.com/open-source/text-analysis/stop-words).
# License
Expand Down

1 comment on commit 6dfef9d

@vercel
Copy link

@vercel vercel bot commented on 6dfef9d Oct 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.