Improve repository structure and documentation #988
+127
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation and comments to various files in the repository. * **README.md**: - Add sections for purpose and usage, repository structure, and dependencies and installation. * **.github/README.md**: - Add a new file explaining the purpose and usage of files within the `.github` directory. * **ci-cd/bitbucket-pipelines/README.md**: - Add sections for purpose and usage, and mention the purpose of `bitbucket-pipelines.yml` and `index.html`. * **ci-cd/github-actions/README.md**: - Add sections for purpose and usage, and mention the purpose of `.gitignore` and `index.html`. * **ci-cd/gitlab-cicd/README.md**: - Add sections for purpose and usage, and mention the purpose of `.gitignore`, `.gitlab-ci.yml`, and `index.html`. * **ci-cd/turborepo-github-actions/README.md**: - Add sections for purpose and usage, directory structure, and dependencies and installation. * **internal/README.md**: - Add a new file explaining the purpose and usage of files within the `internal` directory. * **.eslintrc.json**: - Add inline comments to explain the purpose and usage of specific settings and rules. * **app-directory/css-in-js/next-env.d.ts**: - Add inline comments to explain the purpose and usage of specific settings and rules. * **edge-middleware/feature-flag-optimizely/.eslintrc.json**: - Add inline comments to explain the purpose and usage of specific settings and rules. * **edge-middleware/feature-flag-split/.eslintrc.json**: - Add inline comments to explain the purpose and usage of specific settings and rules. * **edge-middleware/power-parity-pricing-strategies/public/flags/ad.svg**: - Add a descriptive comment to indicate the purpose of the file. * **edge-middleware/power-parity-pricing-strategies/public/flags/ae.svg**: - Add a descriptive comment to indicate the purpose of the file. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/vercel/examples?shareId=XXXX-XXXX-XXXX-XXXX).
Ramyromel
requested review from
okbel,
lfades,
goncy,
dominiksipowicz,
leerob and
lpalmes
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@Ramyromel is attempting to deploy a commit to the Vercel Examples Team on Vercel. A member of the Team first needs to authorize it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation and comments to various files in the repository.
README.md:
.github/README.md:
.githubdirectory.ci-cd/bitbucket-pipelines/README.md:
bitbucket-pipelines.ymlandindex.html.ci-cd/github-actions/README.md:
.gitignoreandindex.html.ci-cd/gitlab-cicd/README.md:
.gitignore,.gitlab-ci.yml, andindex.html.ci-cd/turborepo-github-actions/README.md:
internal/README.md:
internaldirectory..eslintrc.json:
app-directory/css-in-js/next-env.d.ts:
edge-middleware/feature-flag-optimizely/.eslintrc.json:
edge-middleware/feature-flag-split/.eslintrc.json:
edge-middleware/power-parity-pricing-strategies/public/flags/ad.svg:
edge-middleware/power-parity-pricing-strategies/public/flags/ae.svg:
For more details, open the Copilot Workspace session.