Skip to content

docs(readme): add best practices link and remove star history - #1360

Merged
lzjqsdd merged 1 commit into
mainfrom
docs/readme-links-star-history
Jul 27, 2026
Merged

docs(readme): add best practices link and remove star history#1360
lzjqsdd merged 1 commit into
mainfrom
docs/readme-links-star-history

Conversation

@szbr00

@szbr00 szbr00 commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the Best Practices documentation link to the README resource list and removes the Star History section from both README files.

Issue Describe / Design

  • The Best Practices page in curvine-doc consolidates production deployment/configuration recommendations; it is now linked from the README documentation resources, directly below Contribute guidelines.
  • The Star History chart is removed from README.md and README_zh.md as it is no longer desired on the project page.
  • The use-case diagram referenced by the README (curvine-scene.png in curvine-doc) is redrawn in the companion PR docs(overview): redraw curvine-scene diagram for the 6 use cases curvine-doc#81; no URL change is needed here since the referenced file path is unchanged.

Changes

Module / File Change Impact on existing behavior
README.md Added Best Practices link; removed Star History section Documentation-only
README_zh.md Removed Star History section Documentation-only

Test verified

Test case Result Notes
Best Practices URL reachable PASS https://curvineio.github.io/docs/User-Manuals/best-practices
Markdown structure check after edit PASS License section is now the last section
make format SKIPPED Markdown-only change; no Rust code touched

Dependencies

Signed-off-by: szbr9486 <curvine86@gmail.com>
@lzjqsdd
lzjqsdd merged commit ef94e63 into main Jul 27, 2026
11 checks passed
@lzjqsdd
lzjqsdd deleted the docs/readme-links-star-history branch July 27, 2026 13:26
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