Skip to content

armgit / Ix

Public Imported from GitHub
0

Understand any codebase instantly. System intelligence for codebases, built for humans and AI.

docs: fix the dead backend repo link, and say what external contributors do (#582)

KageBinary4dd1bef816f6
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 90ba50df..2420cbd4 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -24,5 +24,5 @@ How did you test this?
## Release checklist (if merging to main)
- [ ] `ix-cli/package.json` version bumped
- [ ] After merge: tag pushed (`git tag vX.Y.Z && git push origin vX.Y.Z`)
-- [ ] If backend changes: `ix-memory-layer` tagged and released first
+- [ ] If backend changes: `ix-memory-layer` tagged and released first (maintainers only — see [Backend Development](https://github.com/ix-infrastructure/Ix/blob/main/CONTRIBUTING.md#backend-development))
- [ ] If `docker-compose.standalone.yml` changed: verified `curl | sh` install works
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 65d14216..dbb45214 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -17,7 +17,7 @@ name: Release
# and linux-arm64. Each platform must build its own native binding.
#
# Note: The Scala backend (memory-layer) is built and released separately
-# from the private ix-memory-layer repo. Docker images are pushed to
+# from the private Ix-memory repo. Docker images are pushed to
# ghcr.io/ix-infrastructure/ix-memory-layer from that repo.
# ─────────────────────────────────────────────────────────────────────────────
diff --git a/.github/workflows/security.yml b/.github/workflows/security.yml
index 5d6a7509..1bed54f3 100644
--- a/.github/workflows/security.yml
+++ b/.github/workflows/security.yml
@@ -30,4 +30,4 @@ jobs:
exit-code: 1
scanners: vuln,misconfig
- # Docker image scanning is handled in the private ix-memory-layer repo
+ # Docker image scanning is handled in the private Ix-memory repo
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d60b3ae2..66bcb24a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -152,7 +152,29 @@ All checks fail on CRITICAL or HIGH severity findings. If a check fails on your
## Backend Development
-The Scala backend (memory-layer) lives in a [separate private repo](https://github.com/ix-infrastructure/ix-memory-layer). For backend changes, clone that repo directly.
+The Scala memory-layer backend is developed in a separate, **private** repository
+(`ix-infrastructure/Ix-memory`). Its source is not publicly accessible, so cloning
+it is a maintainer-only step. Note that `ix-memory-layer` — the name used in the
+release notes, `docker-compose.standalone.yml` and the image path in
+`.github/workflows/` — is the published *artifact*, not a repository you can
+clone.
+
+**You do not need the backend source to work on this repository.** Everything in
+the `ix` CLI is developed against the published backend image, which is public and
+pullable anonymously. `./scripts/backend.sh up` in [Local Setup](#local-setup)
+starts it (`ghcr.io/ix-infrastructure/ix-memory-layer:latest` plus ArangoDB, on
+`127.0.0.1:8090` and `:8529`). It installs nothing itself — it runs
+`docker compose -f docker-compose.standalone.yml` against an already-installed
+Docker. What the `curl | sh` *installer* puts on the machine is a separate list:
+[docs/prerequisites.md](docs/prerequisites.md).
+
+If a change you want needs the backend itself — a new endpoint, a different
+response shape, a query that is too slow — open an issue here describing the CLI
+behaviour you need and what the backend would have to do. A maintainer will carry
+it across. Please do not open a PR against this repository that assumes an
+endpoint the released backend does not serve. `ix doctor` reports the running
+graph schema version, and `curl -s localhost:8090/v1/health` returns both that
+and the backend's release version — that release is what to write against.
## OSS vs Pro Boundary