Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: revert "feat(docs): algolia -> typesense" also fix boxes-test #11016

Merged
merged 2 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ jobs:
- uses: actions/checkout@v4
with: { ref: "${{ github.event.pull_request.head.sha }}" }
- uses: ./.github/ci-setup-action
- name: Build Bench Binaries
- name: Build Boxes
uses: ./.github/ensure-builder
timeout-minutes: 40
with:
Expand Down
2 changes: 1 addition & 1 deletion boxes/bootstrap.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function build {
denoise 'yarn && echo "Building... " && yarn build'
cache_upload boxes-$hash.tar.gz boxes/*/{artifacts,dist}
else
denoise yarn
denoise yarn && yarn build
fi
}

Expand Down
12 changes: 6 additions & 6 deletions docs/HOW_WE_WRITE_DOCS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# How we write docs

This doc covers the structure and tone of Aztec developer documentation. For the contribution guidelines, go [here](./CONTRIBUTING.md). Please keep in mind that this is constantly changing.
This doc covers the structure and tone of Aztec developer documentation. For the contribution guidelines, go [here](./CONTRIBUTING.md). Please keep in mind that this is constantly changing.

## Structure

### High level

Aztec docs are divided into two main sections - `Learn` and `Build`.
Aztec docs are divided into two main sections - `Learn` and `Build`.

Anyone technical can read the `Learn` section, whereas only developers who are actively building or starting to build on Aztec will read the `Build` section.

Expand All @@ -16,7 +16,7 @@ The `Build` section contains information that only developers need to know - thi

### Types of pages

The Aztec docs roughly follow the [Diataxis](https://diataxis.fr/) framework. It is recommended to read this website before contributing to the docs.
The Aztec docs roughly follow the [Diataxis](https://diataxis.fr/) framework. It is recommended to read this website before contributing to the docs.

Every page will fall into **one type of doc**. If your contribution covers multiple types, you will need to split it into multiple pages.

Expand All @@ -39,8 +39,8 @@ These are docs that developers can consult to know exact and succinct informatio
## Tone

* Concise and informative - for example, rather than repeating information, write "to learn more, read ..."
* Friendly and empathetic - for example, "you do not have to worry about this yet"
* Simple and jardon-avoidant when possible
* Friendly and empathetic - for example, "you do not have to worry about this yet"
* Simple and jardon-avoidant when possible
* Short sentences
* Unopinionated language - we know things are exciting sometimes, but try not to tell the developer what they should be excited about

Expand Down Expand Up @@ -85,4 +85,4 @@ The Aztec docs use a sidebar - https://docusaurus.io/docs/sidebar/items

## Indexing and Search

Typesense docs search - https://typesense.org/
Algolia docs search - https://docusaurus.io/docs/search#algolia-index-configuration
21 changes: 8 additions & 13 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const config = {
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid", "docusaurus-theme-search-typesense"],
themes: ["@docusaurus/theme-mermaid"],
presets: [
[
"@docusaurus/preset-classic",
Expand Down Expand Up @@ -193,19 +193,14 @@ const config = {
},
],
image: "img/docs-preview-image.png",
typesense: {
typesenseCollectionName: "aztec-docs",
typesenseServerConfig: {
nodes: [
{
host: "cpk69vuom0ilr4abp.a1.typesense.net",
port: 443,
protocol: "https",
},
],
apiKey: "gpH8o2YnqsOEj2jgtIMTULbtHi1kZ2X3", // public search-only api key, safe to commit
},
algolia: {
appId: "CL4NK79B0W",
apiKey: "21d89dadaa37a4d1b6bf4b17978dcf7f",
indexName: "aztec",
contextualSearch: true,
customRanking: [
{ asc: 'importance' },
],
},
colorMode: {
defaultMode: "light",
Expand Down
15 changes: 7 additions & 8 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "aztec-docs",
"name": "my-website",
"version": "0.0.0",
"private": true,
"scripts": {
Expand All @@ -17,15 +17,14 @@
},
"dependencies": {
"@cookbookdev/docsbot": "^4.21.12",
"@docusaurus/core": "^3.6.3",
"@docusaurus/plugin-ideal-image": "^3.6.3",
"@docusaurus/preset-classic": "^3.6.3",
"@docusaurus/theme-mermaid": "^3.6.3",
"@docusaurus/core": "^3.0.1",
"@docusaurus/plugin-ideal-image": "^3.0.1",
"@docusaurus/preset-classic": "^3.0.1",
"@docusaurus/theme-mermaid": "^3.0.1",
"@mdx-js/react": "^3.0.1",
"@slorber/react-ideal-image": "^0.0.12",
"axios": "^1.4.0",
"clsx": "^1.1.1",
"docusaurus-theme-search-typesense": "0.23.0-0",
"hast-util-is-element": "1.1.0",
"prism-react-renderer": "^2.1.0",
"prop-types": "^15.8.1",
Expand All @@ -39,8 +38,8 @@
"sharp": "^0.33.3"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.6.3",
"@docusaurus/types": "^3.6.3",
"@docusaurus/module-type-aliases": "^3.0.1",
"@docusaurus/types": "3.0.0",
"@tsconfig/docusaurus": "^1.0.5",
"@types/prop-types": "^15",
"concurrently": "^8.0.1",
Expand Down
47 changes: 0 additions & 47 deletions docs/typesense.config.json

This file was deleted.

Loading
Loading