Skip to content

docs: credit the upstream engine, project page and production README header - #1

Merged
boss477 merged 1 commit into
mainfrom
docs/production-polish
Nov 10, 2026
Merged

boss477 merged 1 commit into
mainfrom
docs/production-polish

Conversation

@boss477

@boss477 boss477 commented Nov 10, 2026 •

Copy link
Copy Markdown
Owner
  • README: a centred header that names the hackathon work (BrainVault, the agentic chat pipeline) and credits the HippocampAI engine by Rex Divakar (rexdivakar/HippocampAI, Apache 2.0), which the package metadata already names as the author. Emoji removed from five headings and two lines; no other text changed.
  • CODE_OF_CONDUCT, SUPPORT, an issue config with the private security link, and a PR template. CONTRIBUTING and SECURITY already exist in docs/ and are untouched.
  • site/: the project page, published by .github/workflows/pages.yml to https://boss477.github.io/HippocampAI/.
  • Repository settings applied separately: description, topics and private vulnerability reporting (the SECURITY policy links to it).

🤖 Generated with Claude Code


Summary by cubic

Polishes the project for production: the README header now credits the upstream HippocampAI engine by Rex Divakar (Apache 2.0), names the hackathon work, and drops emoji from headings and lines.

  • Adds CODE_OF_CONDUCT, SUPPORT, an issue config pointing security reports to private advisories, and a pull request template.
  • Adds a project page in site/, deployed to https://boss477.github.io/HippocampAI/ by a GitHub Pages workflow.

Written for commit f6d8b88. Summary will update on new commits.

View guided diff Turn on auto-fix

…header

- README: a centred header that names the hackathon work (BrainVault, the agentic chat pipeline) and credits the HippocampAI engine by Rex Divakar (rexdivakar/HippocampAI, Apache 2.0), which the package metadata already names as the author. Emoji removed from five headings and two lines; no other text changed.
- CODE_OF_CONDUCT, SUPPORT, an issue config with the private security link, and a PR template. CONTRIBUTING and SECURITY already exist in docs/ and are untouched.
- site/: the project page, published by .github/workflows/pages.yml to https://boss477.github.io/HippocampAI/.
- Repository settings applied separately: description, topics and private vulnerability reporting (the SECURITY policy links to it).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 10, 2026

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 9f743a25-eb56-4608-bfa5-17f8015bcc8f
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

3 issues found across 7 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="SUPPORT.md">

<violation number="1" location="SUPPORT.md:6">
P2: This security link is broken: the repository contains `docs/SECURITY.md`, not root-level `SECURITY.md`, and the linked document would not direct a reporter to the private advisory form anyway. Link directly to the private vulnerability reporting URL (and optionally the policy) so security reports do not become blocked or public.</violation>
</file>

<file name="README.md">

<violation number="1" location="README.md:13">
P3: This hard-coded badge misstates the supported Python range by presenting 3.11 as the project version. Use a badge that reflects the declared `>=3.9` support (or a dynamic PyPI versions badge) so users do not miss compatible Python versions.</violation>
</file>

<file name=".github/pull_request_template.md">

<violation number="1" location=".github/pull_request_template.md:9">
P3: This checkbox refers to BrainVault export/restore tools that are not present in the repository, so contributors cannot perform the requested verification. Remove this repository-specific requirement or add the referenced implementation before asking contributors to test it.</violation>
</file>

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread .github/workflows/pages.yml Resolved
Comment thread SUPPORT.md
- **Something is broken:** open an issue with the bug report form. Include what you ran, what you
expected and what happened.
- **An idea or a missing feature:** open an issue with the feature request form.
- **A security problem:** do not open a public issue. Follow [SECURITY.md](SECURITY.md).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2: This security link is broken: the repository contains docs/SECURITY.md, not root-level SECURITY.md, and the linked document would not direct a reporter to the private advisory form anyway. Link directly to the private vulnerability reporting URL (and optionally the policy) so security reports do not become blocked or public.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At SUPPORT.md, line 6:

<comment>This security link is broken: the repository contains `docs/SECURITY.md`, not root-level `SECURITY.md`, and the linked document would not direct a reporter to the private advisory form anyway. Link directly to the private vulnerability reporting URL (and optionally the policy) so security reports do not become blocked or public.</comment>

<file context>
@@ -0,0 +1,9 @@
+- **Something is broken:** open an issue with the bug report form. Include what you ran, what you
+  expected and what happened.
+- **An idea or a missing feature:** open an issue with the feature request form.
+- **A security problem:** do not open a public issue. Follow [SECURITY.md](SECURITY.md).
+
+This project is maintained in the open by [@boss477](https://github.com/boss477). Answers are best
</file context>
Suggested change
- **A security problem:** do not open a public issue. Follow [SECURITY.md](SECURITY.md).
- **A security problem:** do not open a public issue. [Report it privately](https://github.com/boss477/HippocampAI/security/advisories/new).

Comment thread README.md Resolved
Comment thread README.md
<p align="center">
<a href="https://github.com/boss477/HippocampAI/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/boss477/HippocampAI/actions/workflows/ci.yml/badge.svg"></a>
<a href="LICENSE"><img alt="license: Apache 2.0" src="https://img.shields.io/badge/license-Apache%202.0-1b5e3b"></a>
<img alt="python: 3.11" src="https://img.shields.io/badge/python-3.11-1b5e3b?logo=python&logoColor=white">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P3: This hard-coded badge misstates the supported Python range by presenting 3.11 as the project version. Use a badge that reflects the declared >=3.9 support (or a dynamic PyPI versions badge) so users do not miss compatible Python versions.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At README.md, line 13:

<comment>This hard-coded badge misstates the supported Python range by presenting 3.11 as the project version. Use a badge that reflects the declared `>=3.9` support (or a dynamic PyPI versions badge) so users do not miss compatible Python versions.</comment>

<file context>
@@ -1,14 +1,28 @@
+<p align="center">
+  <a href="https://github.com/boss477/HippocampAI/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/boss477/HippocampAI/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="LICENSE"><img alt="license: Apache 2.0" src="https://img.shields.io/badge/license-Apache%202.0-1b5e3b"></a>
+  <img alt="python: 3.11" src="https://img.shields.io/badge/python-3.11-1b5e3b?logo=python&logoColor=white">
+  <img alt="SanDisk Hackathon: 1st runner-up" src="https://img.shields.io/badge/SanDisk%20Hackathon-1st%20runner--up-b08900">
+  <a href="https://boss477.github.io/HippocampAI/"><img alt="website: boss477.github.io" src="https://img.shields.io/badge/website-boss477.github.io-1b5e3b"></a>
</file context>
Suggested change
<img alt="python: 3.11" src="https://img.shields.io/badge/python-3.11-1b5e3b?logo=python&logoColor=white">
<img alt="python: 3.9+" src="https://img.shields.io/badge/python-3.9%2B-1b5e3b?logo=python&logoColor=white">


- [ ] `pytest` passes
- [ ] `ruff check .` and `ruff format --check .` are clean
- [ ] Tried the BrainVault export and restore if the change touches them

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P3: This checkbox refers to BrainVault export/restore tools that are not present in the repository, so contributors cannot perform the requested verification. Remove this repository-specific requirement or add the referenced implementation before asking contributors to test it.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At .github/pull_request_template.md, line 9:

<comment>This checkbox refers to BrainVault export/restore tools that are not present in the repository, so contributors cannot perform the requested verification. Remove this repository-specific requirement or add the referenced implementation before asking contributors to test it.</comment>

<file context>
@@ -0,0 +1,14 @@
+
+- [ ] `pytest` passes
+- [ ] `ruff check .` and `ruff format --check .` are clean
+- [ ] Tried the BrainVault export and restore if the change touches them
+
+## Checklist
</file context>
Suggested change
- [ ] Tried the BrainVault export and restore if the change touches them
- [ ] Tried the relevant feature flow if the change touches it

@boss477
boss477 merged commit 86b3e8e into main Nov 10, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant