Feat: Add Portuguese (pt-BR) translation

.gitignore

@@ -1,24 +1,41 @@
-# build output
-dist/
-# generated types
-.astro/
-
-# dependencies
-node_modules/
-
-# logs
+# Logs
+logs
+*.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-pnpm-debug.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+.report/
 
-# environment variables
+# Runtime data
+pids
+*.pid
+*.seed
+*.info
 .env
-.env.production
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
-# macOS-specific files
-.DS_Store
+# Next.js
+.next/
+out/
+
+# Astro
+.astro/
+
+# Dependencies
+node_modules/
+.pnpm-store/
 
-# swap vim files
-*.swp
-*.swo
+# IDEs and other
+.idea/
+.vscode/
+*.sublime-project
+*.sublime-workspace
+*.DS_Store
+Thumbs.db

README.md

@@ -1,12 +1,40 @@
-# Atuin docs
+# Atuin Documentation
 
-This powers docs.atuin.sh
+![Atuin Logo Dark](.github/logo-dark.png)
 
-You will find markdown files within src/content/docs
+This repository contains the source code for the official Atuin documentation, hosted at [docs.atuin.sh](https://docs.atuin.sh).
 
-Get started with
+Atuin is a **magical shell history** tool that replaces your shell's default history with a SQLite database, providing a powerful search interface and optional cloud synchronization.
 
-```
-npm install
-npm run dev
-```
+![Atuin Preview](.github/preview.png)
+
+## Project Structure
+
+The documentation content is primarily written in Markdown (and MDX) and is located in the `src/content/docs` directory.
+
+## Getting Started (Local Development)
+
+To set up and run the documentation site locally, follow these steps:
+
+1.  **Clone the repository:**
+    ```bash
+    git clone https://github.com/atuinsh/atuin-docs.git
+    cd atuin-docs
+    ```
+
+2.  **Install dependencies:**
+    ```bash
+    npm install
+    ```
+
+3.  **Start the development server:**
+    ```bash
+    npm run dev
+    ```
+    This will start a local development server, usually accessible at `http://localhost:4321`. The site will automatically reload as you make changes to the source files.
+
+## Contributing
+
+We welcome contributions to improve the Atuin documentation! If you find an error, want to clarify a section, or add new content, please feel free to open an issue or submit a pull request.
+
+Before contributing, please ensure your changes align with the existing documentation style and guidelines.

astro.config.mjs

@@ -53,9 +53,47 @@ export default defineConfig({
         linkedin: 'https://www.linkedin.com/company/atuin/'
       },
 
-      defaultLocale: "root",
+      defaultLocale: "en",
       locales: {
-        root: { label: "English", lang: "en" }
+        en: { label: "English", lang: "en" },
+        "pt-br": {
+          label: "Português (Brasil)",
+          lang: "pt-BR",
+          sidebar: [
+            {
+              label: 'Guia',
+              items: [
+                { label: 'Instalação', link: '/pt-br/guide/installation' },
+                { label: 'Configurando a sincronização', link: '/pt-br/guide/sync' },
+                { label: 'Importar histórico existente', link: '/pt-br/guide/import' },
+                { label: 'Uso básico', link: '/pt-br/guide/basic-usage' },
+                { label: 'Sincronizando dotfiles', link: '/pt-br/guide/dotfiles' },
+                { label: 'Temas', link: '/pt-br/guide/theming' },
+              ],
+            },
+            {
+              label: 'Configuração',
+              autogenerate: { directory: 'configuration' },
+            },
+            {
+              label: 'Referência',
+              autogenerate: { directory: 'reference' },
+            },
+            {
+              label: 'Auto-hospedagem',
+              items: [
+                { label: 'Configuração do servidor', link: '/pt-br/self-hosting/server-setup' },
+                { label: 'Uso', link: '/pt-br/self-hosting/usage' },
+                { label: 'Docker', link: '/pt-br/self-hosting/docker' },
+                { label: 'Kubernetes', link: '/pt-br/self-hosting/kubernetes' },
+                { label: 'Systemd', link: '/pt-br/self-hosting/systemd' },
+              ],
+            },
+            { label: 'Problemas conhecidos', link: '/pt-br/known-issues' },
+            { label: 'Integrações', link: '/pt-br/integrations' },
+            { label: 'Perguntas Frequentes', link: '/pt-br/faq' },
+          ],
+        }
       },
 
       sidebar: [

package.json

@@ -13,6 +13,7 @@
     "@astrojs/check": "^0.5.6",
     "@astrojs/starlight": "^0.20.1",
     "astro": "^4.4.6",
+    "git-commit-msg-linter": "^5.0.8",
     "rehype-autolink-headings": "^7.1.0",
     "rehype-slug": "^6.0.0",
     "sharp": "^0.33.2",

src/content/docs/configuration/config.mdx

@@ -233,7 +233,7 @@ Default: `40`
 
 Set the maximum number of lines Atuin's interface should take up.
 
-![inline_height](../../../assets/inline.png)
+![inline_height](/inline.png)
 
 If set to `0`, Atuin will always take up as many lines as available (full screen).
 
@@ -243,7 +243,7 @@ Default: `true`
 
 Configure whether or not to show a preview of the selected command.
 
-![show_preview](../../../assets/preview.png)
+![show_preview](/preview.png)
 
 Useful when the command is longer than the terminal width and is cut off.