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

docs: rearranged cli/runtime related sections #6275

Merged
merged 7 commits into from
Oct 10, 2023

Conversation

cyfung1031
Copy link
Contributor

@cyfung1031 cyfung1031 commented Oct 3, 2023

What does this PR do?

  • Documentation or TypeScript types (it's okay to leave the rest blank in this case)
  • Code changes

How did you verify your code works?

N/A

Reason and Changes

Added Scaffolding section (docs/scaffolding/)

  • The project creation (folder scaffolding) should not put inside intro, it should be a new section before cli bun run
  • Intro shall focus on the overall first time usage, like how to install and Quickstart.
  • bun init and bun create shall be separated into two different sub pages, as users shall use either bun init or bun create to scaffold a new project. (docs/scaffolding/bun-create.md and docs/scaffolding/bun-init.md)
  • typescript settings shall be part of the scaffolding, not intro. (docs/scaffolding/typescript.md)

Extracted bun add --global into separate sub page. (docs/install/global-install.md)

  • bun add --global is not to adding package to the local project folder.
  • As it does not modify any file (e.g. package.json) inside the local project folder, it should be extracted as a new sub page.

Relocated or Removed obsoleted files docs/typescript.md, docs/cli/bun-init.md, and docs/templates.md

Added Information in installation.md for the manual global installation setup in macOS / Linux (bash).

Updated nav.ts accordingly

Updated README.md for the revised docs path.

Added bun --version and bun --revision in installation.md for users to check the installation.

@colinhacks colinhacks merged commit 44dd744 into oven-sh:main Oct 10, 2023
1 check passed
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