Skip to content

docs: standardize feature README sections across demos#17

Closed
however-yir wants to merge 3 commits into
qifan777:mainfrom
however-yir:codex/dive-standardize-demo-readme
Closed

docs: standardize feature README sections across demos#17
however-yir wants to merge 3 commits into
qifan777:mainfrom
however-yir:codex/dive-standardize-demo-readme

Conversation

@however-yir
Copy link
Copy Markdown

Summary

Standardize the frontend demo README into a project-specific structure.

Why

The current file is still the default Vite template, which means readers do not get project-specific setup guidance where they expect it. A short README with clear sections for overview, setup, run, and expected behavior is more useful for contributors.

Scope

  • rewrite front-end/README.md into a project-specific guide
  • standardize the sections around overview, prerequisites, setup, run, and expected behavior
  • keep the document concise and focused on the current frontend workflow

Testing

  • documentation-only changes
  • reviewed the commands and config references against the current frontend package scripts and env files

@however-yir however-yir closed this by deleting the head repository Apr 20, 2026
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.

1 participant