This is an automated email from the ASF dual-hosted git repository. jamesbognar pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/juneau.git
commit 40163d51734e140a899ca6e30eb0180323c8f8e2 Author: James Bognar <[email protected]> AuthorDate: Fri Nov 14 09:12:52 2025 -0500 Added Algolia search --- .gitignore | 2 +- CLAUDE.md => AI.md | 22 ++++++++++++++++------ juneau-docs/docusaurus.config.ts | 30 ++++++++++++++++++++++++++++++ pom.xml | 15 --------------- 4 files changed, 47 insertions(+), 22 deletions(-) diff --git a/.gitignore b/.gitignore index d316a2284c..5ee8d17e92 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,4 @@ cursor-* /coverage/ /coverage.csv /coverage.exec -/CLAUDE_SESSION.md +/AI_SESSION.md diff --git a/CLAUDE.md b/AI.md similarity index 97% rename from CLAUDE.md rename to AI.md index 3220dc1ab6..f28083f484 100644 --- a/CLAUDE.md +++ b/AI.md @@ -1,12 +1,12 @@ -# Claude AI Assistant Rules for Apache Juneau +# AI Assistant Rules for Apache Juneau -This document outlines the rules, guidelines, and best practices that Claude AI follows when working on the Apache Juneau project. +This document outlines the rules, guidelines, and best practices that AI assistants follow when working on the Apache Juneau project. **Note**: This file is referred to as "my rules" and serves as the definitive reference for all guidelines and conventions I follow when working on the Apache Juneau project. -**Important**: Also read `CLAUDE_SESSION.md` to understand the current session's work context, what we're currently working on, and any recent changes or patterns established in this session. +**Important**: Also read `AI_SESSION.md` to understand the current session's work context, what we're currently working on, and any recent changes or patterns established in this session. -**Documentation Separation Rule**: `CLAUDE_SESSION.md` should only contain session-specific information that is not already covered in `CLAUDE.md`. General rules, permanent conventions, and best practices belong in `CLAUDE.md`. Session-specific work progress, current tasks, and temporary patterns belong in `CLAUDE_SESSION.md`. +**Documentation Separation Rule**: `AI_SESSION.md` should only contain session-specific information that is not already covered in `AI.md`. General rules, permanent conventions, and best practices belong in `AI.md`. Session-specific work progress, current tasks, and temporary patterns belong in `AI_SESSION.md`. ## User Commands @@ -15,9 +15,19 @@ This document outlines the rules, guidelines, and best practices that Claude AI - **"s"** means **"status"** - When the user sends just "s", give a status update on what you're currently working on - **"TODO-x"** means **"work on this TODO"** - When the user sends just "TODO-3", "TODO-67", etc., start working on that specific TODO item from the TODO.md file +### Script Shortcut Commands +- **"start docs"** or **"start docusaurus"** - Runs `scripts/start-docusaurus.py` +- **"revert staged"** - Runs `scripts/revert-staged.py` +- **"revert unstaged"** - Runs `scripts/revert-unstaged.py` +- **"start jetty"** - Runs `scripts/start-examples-rest-jetty.py` +- **"start springboot"** - Runs `scripts/start-examples-springboot.py` +- **"push [commit message]"** - Runs `scripts/build-and-push.py` with the commit message. Example: "push Added Algolia search" +- **"test"** - Runs `scripts/build-and-test.py` + ### Documentation Commands -- **"store this rule in the session"** - Add the rule/information to `CLAUDE_SESSION.md` (session-specific) -- **"store this rule in the context"** - Add the rule/information to `CLAUDE.md` (permanent/general) +- **"save a rule"** or **"save this rule"** - Add the rule/information to `AI.md` (permanent/general) +- **"store this rule in the session"** - Add the rule/information to `AI_SESSION.md` (session-specific) +- **"store this rule in the context"** - Add the rule/information to `AI.md` (permanent/general) ## Core Working Principles diff --git a/juneau-docs/docusaurus.config.ts b/juneau-docs/docusaurus.config.ts index 4575f93579..1ce26575e3 100644 --- a/juneau-docs/docusaurus.config.ts +++ b/juneau-docs/docusaurus.config.ts @@ -86,6 +86,36 @@ const config: Config = { themeConfig: { // Replace with your project's social card image: 'img/docusaurus-social-card.jpg', + algolia: { + // The application ID provided by Algolia + appId: 'DVIGEYTUK7', + + // Public API key: it is safe to commit it + apiKey: 'db9fd10aa92e0ad212e08340e37293c0', + + indexName: 'juneau_docs', + + // Optional: see doc section below + contextualSearch: true, + + // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them. + // externalUrlRegex: 'external\\.com|domain\\.com', + + // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs + // replaceSearchResultPathname: { + // from: '/docs/', // or as RegExp: /\/docs\// + // to: '/', + // }, + + // Optional: Algolia search parameters + searchParameters: {}, + + // Optional: path for search page that enabled by default (`false` to disable it) + searchPagePath: 'search', + + // Optional: whether the insights feature is enabled or not on Docsearch (`false` by default) + insights: false, + }, navbar: { title: 'Apache Juneau', logo: { diff --git a/pom.xml b/pom.xml index df7db4689d..3455234431 100644 --- a/pom.xml +++ b/pom.xml @@ -400,20 +400,5 @@ <name>Ayeshmantha Perera</name> <roles><role>PMC</role></roles> </developer> - <developer> - <id>ggregory</id> - <name>Gary Gregory</name> - <email>ggregory at apache.org</email> - <url>https://www.garygregory.com</url> - <organization>The Apache Software Foundation</organization> - <organizationUrl>https://www.apache.org/</organizationUrl> - <roles> - <role>PMC Member</role> - </roles> - <timezone>America/New_York</timezone> - <properties> - <picUrl>https://people.apache.org/~ggregory/img/garydgregory80.png</picUrl> - </properties> - </developer> </developers> </project>
