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.

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

docs: add .env to directory structure and improve config docs #18594

Merged
merged 7 commits into from Feb 1, 2023
Merged

docs: add .env to directory structure and improve config docs #18594

merged 7 commits into from Feb 1, 2023

Conversation

danielroe
Copy link
Member

@danielroe danielroe commented Jan 28, 2023 •
edited

🔗 Linked issue

resolves #14989
resolves #12390

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This is a PR (still in-progress) to improve our documentation of how runtime config works and how it should be used. (And in particular, any caveats that users need to be aware of.)

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@danielroe danielroe self-assigned this Jan 28, 2023
@codesandbox
Copy link

codesandbox bot commented Jan 28, 2023

CodeSandbox logoCodeSandbox logo  Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

@danielroe @Atinux
Update docs/2.guide/3.going-further/10.runtime-config.md
47bf710 
Co-authored-by: Sébastien Chopin <seb@nuxt.com>
@danielroe danielroe requested a review from pi0 January 31, 2023 21:07
@danielroe danielroe marked this pull request as ready for review January 31, 2023 22:32
@danielroe danielroe mentioned this pull request Jan 31, 2023
Merged
7 tasks
@danielroe danielroe changed the title docs: add .env to directory structure and improve docs docs: add .env to directory structure and improve config docs Feb 1, 2023
@danielroe danielroe merged commit a887418 into main Feb 1, 2023
@danielroe danielroe deleted the docs/runtime-config branch February 1, 2023 11:53
@danielroe danielroe mentioned this pull request Feb 1, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Atinux Atinux Atinux left review comments

@pi0 pi0 pi0 approved these changes

Assignees

@danielroe danielroe

Labels
3.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs] add runtimeConfig / appConfig explainer add note about --dotenv in dev to runtime config page
3 participants
@danielroe @Atinux @pi0