diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..3aff9a0 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "i18n-ally.localesPaths": ["docs/locales"] +} diff --git a/README.md b/README.md index ce559d2..4fe5c3f 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ If you've already installed all the deps and want more granular control you can ```bash # start Docker services (you must have Docker installed) -docker compose up +docker compose up -d # or pnpm run up @@ -29,100 +29,3 @@ pnpm run watch A browser window should now have opened up pointing to `http://localhost:3333`. See you over there. - -## Content Types - - - -+++ **1. API Documents** -- RUST indexes - - _will create index references to all **RUST symbols** and home page_ - - [Home Page](https://docs.rs/tauri/latest/tauri/) plus sections in home page - - [Re-exports](https://docs.rs/tauri/latest/tauri/#reexports) - - [Modules](https://docs.rs/tauri/latest/tauri/#modules) - - [Structs](https://docs.rs/tauri/latest/tauri/#structs) - - [Functions](https://docs.rs/tauri/latest/tauri/#functions) - - [Type Definitions](https://docs.rs/tauri/latest/tauri/#types) - - **Re-Exports** - - [`tauri-api`](https://docs.rs/tauri-api/latest/tauri_api/index.html) - - **Modules**: - - [`command`](https://docs.rs/tauri-api/latest/tauri_api/command/index.html) - - [`http`](https://docs.rs/tauri-api/latest/tauri_api/http/index.html) - - etc. - - **Functions**: - - [`make_request`](https://docs.rs/tauri-api/latest/tauri_api/http/fn.make_request.html) - - - - **Enums** - - [`http::ResponseType`](https://docs.rs/tauri-api/latest/tauri_api/http/enum.ResponseType.html) - - [`tauri_api::dialog::Response`](https://docs.rs/tauri-api/latest/tauri_api/dialog/enum.Response.html) - - etc. - - **Type Definitions**: - - [`Result`](https://docs.rs/tauri/latest/tauri/type.Result.html) - - etc. - - _all indexes will point directly to `docs.rs`_ -- Typescript indexes - - _we will host the API docs on [Tauri's Website](https://tauri.studio) and all search indexes will point there_ - - indexes will largely mirror what we are doing on the Rust side -+++ - -- **Primary / Prose Documentation** - - _all sections will be authored in English and using Markdown format_ - - _we will need separate indexes for `i18n` content_ - - _All documentation outside of generated API docs will be considered part of this section_ - - The current site includes these areas: - - About - - Docs section - - Community - - Configuration - -## Indexes - -### [Meilisearch Index Overview](https://docs.meilisearch.com/learn/core_concepts/indexes.html#index-creation) - - - -### [Meilisearch Relevance Overview](https://docs.meilisearch.com/learn/core_concepts/relevancy.html) - -Meilisearch provides **Ranking Rules** which you can use to help tune each index's strategy. The default rule ordering is as follows (most significant first): - -1. Words -1. Typo -1. Proximity -1. Attribute -1. Sort -1. Exactness - -Rule #4 above -- `Attribute` -- points to another ranking system: **Attribute Ranking**. Attribute Ranking allows you to state the order of importance of each attribute in a document. - -### Tauri Indexes - -- `rust` - -- `typescript` - -- `docs` - we may break this up into further indexes later but best to start with the KISS principle - -## Documents - -Documents are key-value pairs (referred to as attribute/value in Meili speak). - -- The "Primary Field" is the only _required_ attribute/value pair. It will always have a key of `id` and it's value contains the primary key and document identifier. -- Data can be ingested in any of the three formats: - - JSOn - - [NDJSON](https://docs.meilisearch.com/learn/core_concepts/documents.html#ndjson) - - CSV -- In general we should prefer NDJSON where possible as it has better performance than JSON and also allows for nested data. - -## Deployment Environments - -You can test everything locally by firing up the included Docker compose configuration: `docker compose up` but for production Meilisearch has three pre-configured setups that Meilisearch provides: - -- [AWS](https://github.com/meilisearch/meilisearch-aws) -- [Digital Ocean](https://github.com/meilisearch/meilisearch-digitalocean) -- [GCP](https://github.com/meilisearch/meilisearch-gcp) - -I prefer AWS out of familiarity but also: -- arguably their investment in Rust might facilitate future synergies -- since we use Netlify for hosting and Netlify uses AWS for functions and basic CDN (advanced CDN is via Cloudflare) - -That said, we probably need to consider Digital Ocean too simply because that is the status quo. I'd avoid GCP. - -> Note: for local experimentation you can use the Meilisearch API directly at http://localhost:7700 or fire up the demo app with `pnpm run demo` \ No newline at end of file diff --git a/docs/LICENSE b/docs/LICENSE.md similarity index 92% rename from docs/LICENSE rename to docs/LICENSE.md index da26da3..c34cf79 100644 --- a/docs/LICENSE +++ b/docs/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020-2021 Anthony Fu +Copyright (c) 2020-2021 The Tauri Programme in the Commons Conservancy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +SOFTWARE. \ No newline at end of file diff --git a/docs/package.json b/docs/package.json index c3bf1ca..c1ba7e2 100644 --- a/docs/package.json +++ b/docs/package.json @@ -19,7 +19,7 @@ "nprogress": "^0.2.0", "pinia": "^2.0.9", "prism-theme-vars": "^0.2.2", - "tauri-search": "link:../", + "tauri-search": "workspace:*", "ts-morph": "^13.0.3", "vue": "^3.2.28", "vue-demi": "^0.12.1", diff --git a/docs/src/components.d.ts b/docs/src/components.d.ts index d713694..1eda0bc 100644 --- a/docs/src/components.d.ts +++ b/docs/src/components.d.ts @@ -4,12 +4,9 @@ declare module 'vue' { export interface GlobalComponents { - 'AntDesign:fileMarkdownOutlined': typeof import('~icons/ant-design/file-markdown-outlined')['default'] 'Bx:bxSearchAlt': typeof import('~icons/bx/bx-search-alt')['default'] 'Carbon:document': typeof import('~icons/carbon/document')['default'] - 'Carbon:errorFilled': typeof import('~icons/carbon/error-filled')['default'] 'Carbon:listDropdown': typeof import('~icons/carbon/list-dropdown')['default'] - 'Carbon:nextFilled': typeof import('~icons/carbon/next-filled')['default'] CarbonLanguage: typeof import('~icons/carbon/language')['default'] CarbonMoon: typeof import('~icons/carbon/moon')['default'] CarbonSun: typeof import('~icons/carbon/sun')['default'] @@ -17,10 +14,8 @@ declare module 'vue' { 'Fluent:databaseSearch24Regular': typeof import('~icons/fluent/database-search24-regular')['default'] Footer: typeof import('./components/Footer.vue')['default'] 'Mdi:folderHome': typeof import('~icons/mdi/folder-home')['default'] - 'Mdi:github': typeof import('~icons/mdi/github')['default'] 'Mdi:languageRust': typeof import('~icons/mdi/language-rust')['default'] 'Mdi:languageTypescript': typeof import('~icons/mdi/language-typescript')['default'] - 'Ph:linkLight': typeof import('~icons/ph/link-light')['default'] README: typeof import('./components/README.md')['default'] SearchActions: typeof import('./components/SearchActions.vue')['default'] SearchHit: typeof import('./components/SearchHit.vue')['default'] @@ -29,8 +24,6 @@ declare module 'vue' { SimpleCard: typeof import('./components/SimpleCard.vue')['default'] 'Tabler:databaseImport': typeof import('~icons/tabler/database-import')['default'] 'Teenyicons:dockerOutline': typeof import('~icons/teenyicons/docker-outline')['default'] - 'VscodeIcons:fileTypeRust': typeof import('~icons/vscode-icons/file-type-rust')['default'] - 'VscodeIcons:fileTypeTypescriptOfficial': typeof import('~icons/vscode-icons/file-type-typescript-official')['default'] } } diff --git a/docs/src/components/SimpleCard.vue b/docs/src/components/SimpleCard.vue index b6b9af3..5d0f688 100644 --- a/docs/src/components/SimpleCard.vue +++ b/docs/src/components/SimpleCard.vue @@ -1,6 +1,7 @@