Repository navigation
docs(readme): refresh README and add website metadata - #487
Merged
Merged
Conversation
Audited against main 1055d37: provider list, dreaming status, memory modes, web UI views, encryption ciphers and dev commands were stale or missing. Adds website/docs badges and links, a common-options table with defaults from src/config.ts, and brings the five translations back in line with README.md.
Points npm at the website and the issue tracker. Release only runs on v* tags, so this does not publish.
Adds og:site_name, og:locale, og:image size and alt, twitter:image:alt and rel=sitemap to the landing page, og:image size and alt to docs, and description, image, sameAs, author and isAccessibleForFree to the SoftwareApplication JSON-LD.
Only /docs/ is generated from the README; the landing page lives in site/src/. Auto-cleanup also deletes prompts older than the retention window (cleanup-service.ts deleteOldPrompts). Docs pages get twitter:image:alt, and both social alt tags read one string from site/src/i18n/en.ts.
3 tasks done
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
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.
Summary
README audited against
main@1055d37f42f9deee3e0377f7be23b05b9747fa9e(v2.40.1 + #486).Stale, now fixed
src/config.tshas 10 manualmemoryProvidervalues plus any OpenCode provider viaopencodeProvider. Rewritten as a list covering features that exist in code (Markdown vault, update-on-capture, dreaming, credential redaction, encryption, export/import/migrate, Basic Auth).dreaming-service.tsactionsmerge|update|supersede|keep|flag,dreaming.crossProject). Removed.memorymodes table lackedhelp(tool enum insrc/index.ts/src/v2/adapter.ts).web/src/lib/routes.ts). Added the views,webServerPort,webServerEnabled.databaseEncryptionCipheraccepts 7 ciphers (defaultaes256gcm).bun install / build / test / check(matchespackage.jsonscripts and AGENTS.md), plus how the site/docs are generated and thesite/docs-map.jsonrule.Added
dropLines), Website/Docs/npm in License & Links.DEFAULTSinsrc/config.ts, meanings fromopencode-mem.example.jsonc.autoCleanupwording checked incleanup-service.ts(once a day,updated_atcutoff, pinned skipped).site/docs-map.jsonis unchanged.Translations (
.github/i18n/README.{de,zh,ar,tr,nl}.md): updated for the changes above and for older gaps a token check found:recall/recallScope/retrieval_scorerows and paragraphs,embeddingIdleTimeoutMs, the missing-config toast,autoCaptureProviderOrder,Session.NotFoundErrorand V2 event bullets. After the update, every backticked token of every English section exists in the matching translated section (35/35 sections, 5 languages). "Memory credential redaction" stays untranslated as listed indocs-map.json.package.json:
homepageandbugs.urlonly.release.ymlruns onpush: tags: v*, so this does not publish.files,version, scripts and dependencies are unchanged.Site metadata: the live landing page already had canonical, OG, a Twitter card, JSON-LD and lang; docs had canonical, hreflang, OG and Twitter via Starlight; robots.txt and the sitemap were already in place. This PR adds:
og:site_name,og:locale,og:image:width/height/alt,twitter:image:alt,rel=sitemap. JSON-LD gainsdescription,image,sameAs(GitHub, npm),author(copyright holder in LICENSE) andisAccessibleForFree.og:image:width/height/alt.No ratings or counts were added.
Size and Lighthouse (same local static server, mobile, median of 3)
//docs/Test plan
cd site && bun run build && bun run check && node scripts/check-dist.mjs: build OK (158 pages; docs-map and anchor checks pass), astro check 0 errors, check-dist OK.prettier --check .clean; pre-committsc --noEmit+ lint-staged passed.npm pack --dry-run: only LICENSE, README.md, package.json anddist/.dist/index.htmlanddist/docs/index.htmlheads inspected; JSON-LD parses.Checklist