docs: add context7.json and repair unreachable documentation links - #23
Merged
Conversation
Add a repository-root context7.json so documentation indexers parse this repo with the right metadata, scope and usage rules instead of guessing. Validated against https://context7.com/schema/context7.json; folders is left empty because the usable content is spread across the root markdown, skills/, plugins/, extensions/ and src/ rather than concentrated in docs/, which holds only two SVG assets. The exclusions drop CI workflows, lockfiles, changelogs, tests and build scripts, leaving 117 of 143 tracked files indexable. Every rule was checked against the CLI implementation rather than written from memory: `setup <client> [--url <url>]` and `mcp add <client> [--write]` are both declared in src/ui/help.js. Repair two links that do not resolve: - plugins/kiro/POWER.md pointed at https://xmemo.dev/privacy, which returns 404; the published page is /legal/privacy. - the same file linked its licence through file:///h:/repos/memory-os-cli/..., an absolute path from another machine that had leaked into published documentation. It is now the relative ./LICENSE. Extend the README's documentation section with the canonical service documentation tree at xmemo.dev/docs, which this repository did not link to anywhere. All added URLs were verified to return 200. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Context7 currently indexes XMemo only as a website crawl of
xmemo.dev(
/websites/xmemo_dev_product, 34 code snippets, Source ReputationLow, noBenchmark Score). The service repository is private, so a repo-backed library was
assumed to be impossible.
This repository is public, active, and is the actual source of
@xmemo/clientonnpm — 143 tracked files, 101 KB of markdown across 21 documents, plus the CLI
implementation in
src/. Context7 does not index it and it carries nocontext7.json.Comparable libraries in this category sit at 1,442–5,428 snippets. A repo-backed
library is also the only path that earns Source Reputation from real repository
activity, which a website crawl cannot provide.
Changes
context7.json(new) — validated againsthttps://context7.com/schema/context7.jsonwith a real JSON Schema run, not byeye.
descriptionis 180 characters against the schema's 200 limit; the firstdraft was 207 and would have been rejected.
foldersis deliberately left empty so the whole repository is scanned: theusable content is spread across the root markdown,
skills/,plugins/,extensions/andsrc/, whereasdocs/holds only two SVG assets. Simulatingthe config against
git ls-filesgives 117 of 143 tracked files indexed, with26 excluded — CI workflows, lockfiles, changelogs, tests, build scripts and SVGs.
The 16
ruleswere checked against the implementation rather than written frommemory. For example
setup <client-id> [--url <url>]andmcp add <client-id> [--write]are both declared insrc/ui/help.js.Two links that do not resolve:
plugins/kiro/POWER.mdpointed athttps://xmemo.dev/privacy→ HTTP 404.The published page is
/legal/privacy.file:///h:/repos/memory-os-cli/plugins/kiro/LICENSE— an absolute path fromanother machine that had leaked into published documentation. Now
./LICENSE.Both live in files an indexer will read.
README.md— the documentation section did not link to the canonical servicedocumentation tree at
xmemo.dev/docsanywhere in the repository. Added, withquickstart, MCP, tools, API, troubleshooting and
llms.txtentries.Verification
context7.jsonvalidates against the official schema (jsonschema, Draft 2020-12)node --test "test/**/*.test.js"→ 140 passed, 0 failed (before and after)context7.jsonis not published to npm —package.jsonuses afilesallowlistFollow-up (human step)
Adding
context7.jsondoes not itself trigger indexing. The repository still hasto be submitted at https://context7.com/add-library as
https://github.com/yonro/memory-os-cli.After that XMemo has two Context7 libraries:
/websites/xmemo_dev_productfor thehosted service and
/yonro/memory-os-clifor the client.🤖 Generated with Claude Code