Skip to content

docs: improve English discovery and contributor paths - #52

Open
FenjuFu wants to merge 4 commits into
mainfrom
docs/english-readme-visibility
Open

docs: improve English discovery and contributor paths#52
FenjuFu wants to merge 4 commits into
mainfrom
docs/english-readme-visibility

Conversation

@FenjuFu

@FenjuFu FenjuFu commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • rewrite the English README around searchable agent-memory terminology, clearer product positioning, supported hosts, and a faster quick start
  • add direct contributor conversion paths for first issues, bug reports, feature requests, and PR reviews
  • expand CONTRIBUTING.md with setup, repository map, design boundaries, validation, and review guidance
  • add a lightweight GitHub Pages landing page for an owner-controlled, indexable project URL
  • link the website and contribution paths from both English and Chinese READMEs

Visibility changes already configured

  • enabled GitHub Pages at https://iflytek.github.io/memflywheel/ from main:/docs
  • set the repository homepage to that URL
  • added discovery topics: long-term-memory, llm-memory, typescript, opencode, openclaw, and hermes-agent

The 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

  • targeted Prettier check passes for all five changed files
  • git diff --check passes
  • all 40 local Markdown/image links resolve
  • GitHub Pages configuration reports built
  • GitHub issue and contribution URLs return successfully

Notes

The repository-wide pnpm run format:check currently 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.

Copilot AI lite review requested due to automatic review settings August 6, 2026 10:01
Signed-off-by: FenjuFu <fufenjupku@gmail.com>
@FenjuFu
FenjuFu force-pushed the docs/english-readme-visibility branch from 4ecbbce to e4fd20c Compare August 6, 2026 10:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md to clarify product positioning, supported hosts, and quick-start paths, plus added explicit contribution conversion links.
  • Expanded CONTRIBUTING.md with 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 from README.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 .md source 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.

Comment thread docs/index.md Outdated
Comment thread docs/index.md
Copilot AI review requested due to automatic review settings August 6, 2026 10:06

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 .html and .md (e.g., integrations.html in the header but integrations.md later). 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 .md extensions, while the top navigation uses .html. For a GitHub Pages/Jekyll site these should typically point to the generated .html pages 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 .md extensions, 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-description is 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants