Skip to content
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.

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

Documentation improvement #200

Closed
qiushiyan opened this issue Aug 6, 2024 · 1 comment · Fixed by #201
Closed

Documentation improvement #200

qiushiyan opened this issue Aug 6, 2024 · 1 comment · Fixed by #201

Comments

@qiushiyan
Copy link
Contributor

First, great project! It only took me less than 30 minutes to migrate from contentlayer to velite and it brings lots of improvements.

There are a couple of minor issues in the documentation, including capitalization and grammar mistakes. For example, in
nextjs integration
, the second sentence should be here **are** some recipes for help you better integrate Velite with Next.js. and in last modified schema some sentences are not capitalized.

Some wordings can also be improved, e.g.

Considering that Velite's scenario often needs to obtain metadata information about the current file in the schema ...

can be changed to

Since Velite users often need to obtain the current file metadata in the schema ...

In git timestamp the imports of promisify and exec are not shown.

I am not sure if you are actively working on the docs, and if not, is it ok that I make a PR to add doc improvements?

@zce
Copy link
Owner

zce commented Aug 6, 2024

PR welcome

@zce zce closed this as completed Aug 9, 2024
@zce zce linked a pull request Aug 9, 2024 that will close this issue
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 a pull request may close this issue.

2 participants