Skip to content

docs: Update README to reflect gen.isdb=false as default#237

Merged
github-actions[bot] merged 2 commits intomasterfrom
copilot/update-readme-default-value
Feb 28, 2026
Merged

docs: Update README to reflect gen.isdb=false as default#237
github-actions[bot] merged 2 commits intomasterfrom
copilot/update-readme-default-value

Conversation

Copy link
Contributor

Copilot AI commented Feb 28, 2026

gen.isdb defaults to false in application.yml, but documentation still described true (database mode) as the default.

Proposed Changes

  1. Update root README.md — flip default description to gen.isdb=false, swap startup command sections so no-database mode is presented as default
  2. Update src/main/resources/file/README.md — same changes as root README
  3. Update application.yml comment — 默认无数据库(false)为内存存储,true为数据库版本

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as either enhancement, bug, documentation, style or dependencies
  • Verify design and implementation
Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature Request] README更新</issue_title>
<issue_description>### Checklist

  • I searched exising issues and no one else requests similar feature.
  • I think that 25%+ users are positive towards this feature.

Describe the feature

现在gen.isdb=false 是默认值,请更新README

Additional context

No response</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@naming-conventions-bot
Copy link

Thank you for following naming conventions! 😻

@unknowIfGuestInDream unknowIfGuestInDream marked this pull request as ready for review February 28, 2026 06:13
@mergify
Copy link

mergify bot commented Feb 28, 2026

Thanks for opening this pull request!
Please check out the Contributing Guidelines.

@mergify
Copy link

mergify bot commented Feb 28, 2026

@Copilot
Wrong PR Title: [WIP] Update README to reflect default value of gen.isdb
Please check Contributing Guidelines for more information.

Co-authored-by: unknowIfGuestInDream <57802425+unknowIfGuestInDream@users.noreply.github.com>
@what-the-diff
Copy link

what-the-diff bot commented Feb 28, 2026

PR Summary

  • Clarification of Configuration Instructions in application.yml
    • An update in the comment was made to better describe how to configure the database option. The new instruction shows that setting the option to false means using memory for storage, while setting it to true enables the use of a database.

Copilot AI changed the title [WIP] Update README to reflect default value of gen.isdb Update README to reflect gen.isdb=false as default Feb 28, 2026
@unknowIfGuestInDream unknowIfGuestInDream changed the title Update README to reflect gen.isdb=false as default docs: Update README to reflect gen.isdb=false as default Feb 28, 2026
@sonarqubecloud
Copy link

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request automerge labels Feb 28, 2026
@github-actions github-actions bot merged commit 617334e into master Feb 28, 2026
75 checks passed
@github-actions github-actions bot deleted the copilot/update-readme-default-value branch February 28, 2026 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge documentation Improvements or additions to documentation enhancement New feature or request size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request] README更新

2 participants