[hoggmania]

Summary

• move repository structure, local development, verification, and configuration guidance into develope.md
• replace the README sections with a concise link to the new GitHub Pages page
• retain links to engineering documentation

Verification

• documentation structure assertions passed
• local documentation targets exist
• git diff --check passed
• static credential-pattern scan passed

[cubic-dev-ai]

2 issues found across 2 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="develope.md">

<violation number="1" location="develope.md:28">
P2: The OpenGrep worker refuses to analyze a scan unless bubblewrap is installed, but the local prerequisites omit that required sandbox executable. Document bubblewrap (or `SANDBOX_BIN`) alongside the OpenGrep configuration.</violation>

<violation number="2" location="develope.md:34">
P2: These per-module dev commands fail from a clean checkout because they select only the application module while its sibling reactor dependencies, such as `scan-common`, have not been installed. Add `-am` to each command or document a one-time reactor install before starting services.</violation>
</file>

<sub>Reply to a comment to ask cubic a question or push back. It learns from your replies.
Click Fix with cubic on a comment, or reply @cubic-dev-ai fix this, and cubic writes the fix.

View guided diff | Re-trigger cubic</sub>

[cubic-dev-ai]

P2: The OpenGrep worker refuses to analyze a scan unless bubblewrap is installed, but the local prerequisites omit that required sandbox executable. Document bubblewrap (or SANDBOX_BIN) alongside the OpenGrep configuration.

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 develope.md, line 28:

<comment>The OpenGrep worker refuses to analyze a scan unless bubblewrap is installed, but the local prerequisites omit that required sandbox executable. Document bubblewrap (or `SANDBOX_BIN`) alongside the OpenGrep configuration.</comment>

<file context>
@@ -0,0 +1,96 @@
+- Maven 3.9 or newer
+- Temporal (development server or cluster)
+- Git CLI
+- Optional: Postgres for the triage service, OpenGrep binary/configuration, and LLM provider configuration
+
+### Startup
</file context>

Suggested change

	- Optional: Postgres for the triage service, OpenGrep binary/configuration, and LLM provider configuration
	- Optional: Postgres for the triage service, OpenGrep binary/configuration, a bubblewrap executable (`/usr/bin/bwrap` by default), and LLM provider configuration

[cubic-dev-ai]

P2: These per-module dev commands fail from a clean checkout because they select only the application module while its sibling reactor dependencies, such as scan-common, have not been installed. Add -am to each command or document a one-time reactor install before starting services.

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 develope.md, line 34:

<comment>These per-module dev commands fail from a clean checkout because they select only the application module while its sibling reactor dependencies, such as `scan-common`, have not been installed. Add `-am` to each command or document a one-time reactor install before starting services.</comment>

<file context>
@@ -0,0 +1,96 @@
+
+1. Start Temporal. For the development server, set `TEMPORAL_TARGET=localhost:7233` and `TEMPORAL_TLS_ENABLED=false`.
+2. Start the services and workers from the repository root:
+   - `mvn -pl scan-api quarkus:dev`
+   - `mvn -pl scan-worker-workflow quarkus:dev`
+   - `mvn -pl scan-worker-light quarkus:dev`
</file context>

Suggested change

	- `mvn -pl scan-api quarkus:dev`
	- `mvn -pl scan-worker-workflow quarkus:dev`
	- `mvn -pl scan-worker-light quarkus:dev`
	- `mvn -pl scan-worker-filter quarkus:dev`
	- `mvn -pl scan-worker-opengrep quarkus:dev`
	- `mvn -pl scan-api -am quarkus:dev`
	- `mvn -pl scan-worker-workflow -am quarkus:dev`
	- `mvn -pl scan-worker-light -am quarkus:dev`
	- `mvn -pl scan-worker-filter -am quarkus:dev`
	- `mvn -pl scan-worker-opengrep -am quarkus:dev`