docs: improve English discovery and contributor paths - #52
Open
FenjuFu wants to merge 4 commits into
Open
Conversation
Signed-off-by: FenjuFu <fufenjupku@gmail.com>
FenjuFu
force-pushed
the
docs/english-readme-visibility
branch
from
August 6, 2026 10:05
4ecbbce to
e4fd20c
Compare
There was a problem hiding this comment.
Pull request overview
This PR improves MemFlywheel’s English-language discovery and contributor onboarding by rewriting the main README, expanding contribution guidance, and adding a GitHub Pages landing page under /docs for an indexable project URL.
Changes:
- Reworked
README.mdto clarify product positioning, supported hosts, and quick-start paths, plus added explicit contribution conversion links. - Expanded
CONTRIBUTING.mdwith setup steps, repository map, design boundaries, validation guidance, and PR review checklist. - Added a lightweight GitHub Pages entrypoint (
docs/index.md) and Jekyll config (docs/_config.yml), and linked the website/contribution paths fromREADME.zh.md.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Rewrites English discovery + quick start, adds contribution paths, and links the project website. |
| README.zh.md | Links the new project website and adds contribution entrypoints for Chinese readers. |
| docs/index.md | Adds a GitHub Pages landing page with quick start and contributor links. |
| docs/_config.yml | Configures Jekyll theme/metadata for GitHub Pages publishing from /docs. |
| CONTRIBUTING.md | Expands contributor onboarding with setup, repo map, boundaries, validation, and review guidance. |
Suppressed comments (2)
docs/index.md:75
- These internal links point to the Markdown source filenames. On GitHub Pages/Jekyll, the output URLs are typically
.html, so these links are likely broken on the published site.
- [Architecture](architecture.md): storage, recall, extraction, consolidation, and
package boundaries
- [Integrations](integrations.md): Pi, Hermes, OpenCode, OpenClaw, and optional
embedding pre-recall
docs/index.md:77
- Same as above: the published site URL is expected to be
.html, not the.mdsource path, so these links likely won’t resolve on GitHub Pages.
- [Evaluation](evaluation.md): LoCoMo-oriented long-term-memory regression checks
- [Releases](release.md): versioning and npm release workflow
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.
Suppressed comments (4)
docs/index.md:68
- In the GitHub Pages landing page, internal links mix
.htmland.md(e.g.,integrations.htmlin the header butintegrations.mdlater). On a Jekyll-built site, this is likely to produce broken navigation for at least one of the targets; the page should use a single URL style consistently.
Node.js 22.19 or later is required. Continue with the
[full integration and troubleshooting guide](integrations.md).
docs/index.md:75
- The “Learn more” section links to other pages using
.mdextensions, while the top navigation uses.html. For a GitHub Pages/Jekyll site these should typically point to the generated.htmlpages to avoid 404s.
- [Architecture](architecture.md): storage, recall, extraction, consolidation, and
package boundaries
- [Integrations](integrations.md): Pi, Hermes, OpenCode, OpenClaw, and optional
embedding pre-recall
docs/index.md:77
- These links use
.mdextensions, but the page elsewhere links to.html. Aligning them avoids broken navigation on the GitHub Pages build output.
- [Evaluation](evaluation.md): LoCoMo-oriented long-term-memory regression checks
- [Releases](release.md): versioning and npm release workflow
CONTRIBUTING.md:55
- The example branch name
type/short-descriptionis inconsistent with the branch naming guidance immediately below (feat/...,fix/...,docs/..., etc.). Using one of the documented prefixes in the example avoids confusion.
git switch -c type/short-description upstream/main
Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.com>
Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.com>
…into docs/english-readme-visibility Signed-off-by: FenjuFu <92919259+FenjuFu@users.noreply.github.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
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
Visibility changes already configured
https://iflytek.github.io/memflywheel/frommain:/docslong-term-memory,llm-memory,typescript,opencode,openclaw, andhermes-agentThe Pages URL will publish after this PR merges because its source is the default branch. Once live, an owner/full user of the Search Console property can request indexing through URL Inspection; Google does not allow indexing requests for URLs the requester does not manage.
Validation
git diff --checkpassesbuiltNotes
The repository-wide
pnpm run format:checkcurrently reports pre-existing formatting drift across 161 files. The changed files were formatted and pass a targeted check; this PR intentionally avoids unrelated formatting churn.