docs: restore STARTER_KIT breadcrumb to live quick-start and Discord (#57)#241
Closed
Fearvox wants to merge 668 commits into
Closed
docs: restore STARTER_KIT breadcrumb to live quick-start and Discord (#57)#241Fearvox wants to merge 668 commits into
Fearvox wants to merge 668 commits into
Conversation
Use self-deployed embedding and rerank APIs by default See merge request npc-work/aic/ai/evermemos-opensource!64
vLLM Rerank API adopts an instruction-tuned approach See merge request npc-work/aic/ai/evermemos-opensource!65
feat: metrics client and rerank/vectorize/retrieve metrics See merge request npc-work/aic/ai/evermemos-opensource!66
fix:update episode prompt See merge request npc-work/aic/ai/evermemos-opensource!68
feat: add rerank metrics See merge request npc-work/aic/ai/evermemos-opensource!69
* chore: rename project from evermemos to EverCore This commit renames the project directory and updates all internal references from "evermemos" to "EverCore". The changes include: - Renaming the main directory from `methods/evermemos` to `methods/EverCore` - Updating all import paths and module references - Maintaining the same code structure and functionality - Adding new configuration files (.vscode/settings.json, .pylintrc, pyrightconfig.json) - Updating Dockerfile and project metadata * docs: update references from evermemos to EverCore Update documentation files to reflect the renaming of the 'evermemos' directory to 'EverCore'. This includes fixing clone commands, directory paths, and documentation links across multiple files to ensure consistency and correct navigation for users. * chore: rename EverMemOS to EverCore across codebase This is a project-wide rebranding from EverMemOS to EverCore. The changes include: - Update project name in source files, documentation, and configuration - Rename API references, environment variables, and service names - Modify demo descriptions and benchmark configurations - Update URLs and citations to reflect new project identity All functionality remains identical; only naming has changed to align with the new project branding. * docs: update README with EverCore focus and restructured TOC - Add line break before Table of Contents for better visual separation - Rewrite project description to highlight EverCore as the central component - Reorder directory tree to prioritize benchmarks and methods over use-cases - Update use-cases list with more examples and clarify they are templates - Improve flow from Quick Start to use-cases to benchmarks * docs: update README with clearer methods description and benchmarks Add benchmark numbers directly in the method summaries for better visibility. Clarify introductory text to emphasize choice and composition of methods. * docs: fix markdown formatting in README table of contents Adjust whitespace and line breaks to ensure proper rendering of the collapsible table of contents section.
…d-AI#204) - Replace specific EverMemBench-Dynamic badge with general EverMind-AI HuggingFace badge - Remove redundant License badge - Change "Methods" section heading to "Architecture Methods" - Update sub-section headings from h4 (####) to h3 (###) for better hierarchy
…rMind-AI#208) * docs: restructure README and add AGENTS.md for better navigation - Reorder sections to emphasize architecture methods and use cases - Move use cases section before quick start for better flow - Rename "Methods" to "Architecture Methods" for clarity - Add AGENTS.md with quick commands and key entry points - Update section headers to improve document hierarchy - Maintain all existing content while improving organization * docs: add community and contribution files * docs: reorder README directory tree for logical grouping * docs: move community files to .github/ and update references * ci: change deploy workflow trigger from feature branch to main
* docs: restructure README and add subdirectory guides Move the directory tree from the main README to new dedicated README files for each top-level folder (use-cases, methods, benchmarks). Add detailed introductions and tables to guide users to the appropriate subprojects. This improves navigation and provides clear entry points for different use cases. * docs: expand showcase section with new projects and links Add six new project entries to the README showcase, each with a banner image, description, and code/plugin link. Also update an existing benchmark entry to include a dataset link. This enhances the repository's demonstration of real-world applications and available resources.
* docs(readme): update project links and formatting * docs(use-cases): enhance README with visual catalogue of demos Expand the use cases section from a simple table to a detailed visual catalogue with project banners, descriptions, and links. This improves user engagement and provides a better showcase of community integrations and demos. * docs: update READMEs and add validation for use-case links
* docs: update plugin repository link in README * docs(readme): update banner gif link
* docs(readme): add four new use case entries * docs(readme): update outdated banner links to correct github repos
…e-demo-content-payload Fix EverCore demo memory payload
…actions-hygiene Harden GitHub Actions workflows
…bot-config Add Dependabot configuration
…adme-quickstart docs: verify EverCore quickstart path
…I#236) Delete deprecated EvoAgentBench, EverMemBench benchmark suites and HyperMem memory system implementation, including all associated configurations, scripts, and supporting assets.
…57) Issue #57 reported two broken entry points: the Discord invite links and the STARTER_KIT.md quick-start links. Both are now resolved. - The README Discord badge is a live, dynamic shields.io badge that queries the Discord invite API (discord.gg/gYep5nQRZJ) directly, so it both renders the online count and self-validates the invite is alive. - STARTER_KIT.md was removed when the project was restructured into methods/ and benchmarks/ (the quick-start moved into the README). This restores a small breadcrumb at docs/STARTER_KIT.md so old links land on the live README Quick Start, EverCore docs, Discord, and contributing guide instead of a 404. All relative links in the breadcrumb were verified to resolve and the README #quick-start anchor exists. Co-authored-by: LeonTung <zhenhangtung@gmail.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.
docs: restore STARTER_KIT breadcrumb to live quick-start and Discord (closes #57)
Issue #57
("STARTER_KIT.md 和 issue 入口 Discord 链接失效") reported two broken entry
points:
STARTER_KIT.mdquick-start links were broken.Both are now resolved in the current tree, and this PR adds the one missing
piece so old
docs/STARTER_KIT.mdlinks no longer 404.Discord link — fixed (and self-validating)
The README Discord badge is a live, dynamic shields.io badge that queries the
Discord invite API directly:
The invite endpoint returns HTTP 200 with a valid invite payload (guild
tag
EVER), so the badge both renders the live online count and doubles as ahealth check that the invite is alive. No dead Discord link remains.
STARTER_KIT.md — restored as a breadcrumb
docs/STARTER_KIT.mdwas removed when the project was restructured intomethods/andbenchmarks/(commit6324c0c), and its quick-start contentmoved into the README's
## Quick Startsection. That fixed the brokenin-file links by deletion, but left old
docs/STARTER_KIT.mdlinks pointingat a 404.
This PR restores a small breadcrumb at
docs/STARTER_KIT.mdthat redirects tothe current canonical destinations:
README.md#quick-startmethods/EverCore/docsdiscord.gg/gYep5nQRZJ.github/CONTRIBUTING.mdVerification (no live stack needed)
grep -n discord.gg/gYep5nQRZJ README.md→ live invite at README.md:8.curl -s -o /dev/null -w "%{http_code}" "https://discord.com/api/v10/invites/gYep5nQRZJ?with_counts=true"→200.docs/(
README.md,methods/EverCore/docs,.github/CONTRIBUTING.md) and theREADME
#quick-startanchor exists (grep "^## Quick Start" README.md).Scope
One file (
docs/STARTER_KIT.md, +21 lines). Pure docs — no code, no runtimebehavior change.
Credit
The original starter-kit quick-start work is by @ZhenhangTung in
#86 ("docs: fix
STARTER_KIT.md's quick start"); this breadcrumb preserves the intent of that
PR after the restructure absorbed its content into the README.
Co-authored-by: LeonTung zhenhangtung@gmail.com
🤖 Generated with Claude Code