README.md / PURPOSE.md document endpoints, sockets, and service myfs lifecycle scripts that don't exist in the codebase #41
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
The top-level docs describe a Hero-style Unix-socket service with a
service myfsNu-shell lifecycle, a/healthendpoint, and a/.well-known/heroservice.jsondiscovery endpoint. None of that exists in the code ondevelopment. A new user following the README cannot build, run, or health-check the server as documented.Discrepancies
1. Lifecycle / build instructions don't exist.
README.mdandPURPOSE.mdsay:There are no
*.nufiles anywhere in the repo, and noservicewrapper. The real build is plaincargo build --release --workspace; the real way to run the server ismyfs-hub serve --config-path ./server.toml. (Note the CI workflows simultaneously rely on aMakefile+scripts/build_lib.sh— see the separate CI issue — which also don't exist, contradicting the "no Makefiles or bash scripts" claim.)2.
GET /healthdoes not exist. README "Key endpoints" andPURPOSE.md"Key APIs" both listGET /health. Inmyfs-hub/src/server/mod.rsthe only health route isGET /api/v1→handlers::health_check_handler. There is no/healthroute.3.
GET /.well-known/heroservice.jsondoes not exist. Listed in README andPURPOSE.md; no such route is registered inmod.rs(grep -rn well-known --include='*.rs'→ nothing).4. The server does not listen on a Unix socket. README/
PURPOSE.md: "The server (myfs-hub) listens on a Unix socket at~/hero/var/sockets/myfs/rpc.sock". Actual code:tokio::net::TcpListener::bind(format!("{}:{}", config.host, config.port)). NoUnixListener, norpc.sock.Likely cause
The README/
PURPOSE.mdappear to have been written against the target architecture in #35 ("WIP: microservice rearchitecture" —myfs-serverdaemon over UDS,hero_proclifecycle,/health, etc.), which is not yet merged.Suggested fix
Either:
/health,service/hero_proclifecycle) so the docs become true; orREADME.md/PURPOSE.mdto describe the current reality: workspace +cargo build,myfs-hub serve --config-path, TCPhost:port, health atGET /api/v1, and remove theservice myfs/rpc.sock//health//.well-known/heroservice.jsonsections.