8000 Update README by qqpann · Pull Request #14 · qqpann/notcms · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update README #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Apr 27, 2025
Merged

Update README #14

merged 5 commits into from update/readme
Apr 27, 2025

Conversation

qqpann
Copy link
Owner
@qqpann qqpann commented Apr 27, 2025

Description of change

Update README to introduce more detailed instructions

Pull-Request Checklist

  • Code is up-to-date with the main branch
  • pnpm check passes with this change
  • pnpm test passes with this change
  • This pull request links relevant issues as Fixes #0000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change
  • The new commits follow conventions outlined in the conventional commit spec

@Copilot Copilot AI review requested due to automatic review settings April 27, 2025 23:02
@vercel Vercel
Copy link
vercel bot commented Apr 27, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
notcms-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 27, 2025 11:02pm

Copilot
Copilot AI reviewed Apr 27, 2025
View reviewed changes
Copy link
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request updates the README to provide more detailed installation and usage instructions for NotCMS, including information on environment variable setup and schema initialization.

  • Expanded introduction and detailed setup instructions
  • Added "Key Features," "Examples and Templates," and troubleshooting sections
  • Included a new DeepWiki badge for additional reference
Comments suppressed due to low confidence (1)

README.md:131

  • For clarity, consider updating the error examples to reference the exact environment variable names ('NOTCMS_SECRET_KEY' and 'NOTCMS_WORKSPACE_ID') as used elsewhere in the documentation.
If you see errors like "secretKey is required" or "workspaceId is required", make sure:

@qqpann qqpann merged commit d03461c into main Apr 27, 2025
4 of 6 checks passed
@qqpann qqpann deleted the update/readme branch April 27, 2025 23:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@qqpann
0