Skip to content

Commit 00a0765

Browse files
Update README.md
remove practice linked to branches. We are now using versioned doc in docusaurus framework in the main branch.
1 parent 2bf1ede commit 00a0765

File tree

1 file changed

+1
-20
lines changed

1 file changed

+1
-20
lines changed

README.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,7 @@ The deployment process is handled automatically via CloudFlare Pages integration
9090

9191
As a contributor to Dgraph documentation, we ask that you do the following:
9292
- **Label your PR for easy management**: Your PR title should be in the following format: **Topic (area): details**. The **topic** is either "Docs", "Nav" (aka, navigation), or "Chore" (for build fixes, cherry-picks, etc). The **area** is the feature (i.e. "GraphQL"), area of the docs (i.e., "Deployment"), or "Other" (for typo fixes and other bugfix PRs). So, example PR names include:
93-
*Docs(GraphQL): Document the @deprecated annotation* or *Chore(Other): cherry-pick updates from main to release/v20.11*
94-
- **Develop in the `main` branch first**: Make any changes applicable to the current (recently-released) version of Dgraph in the `main` branch first, and then cherry-pick those changes to the correct release branch (for example, `release/v20.11`).
95-
96-
**Exception**: Changes that *only* apply to older Dgraph versions (for example `release/v20.07`), can occur directly in a release branch, but will not be cherry-picked forward.
97-
- **Note planned cherry-pick(s) in your PR description**: If you are creating a PR in `main` and you know it needs to be cherry-picked to a release branch, please mention that in your PR description (for example: "cherry-pick to v20.07"). Cherry-pick PRs should reference the original PR.
98-
99-
- **Link to discuss.dgraph.io posts when applicable**: If your PR is based on discussions on Discuss, feel free to include a link to the relevant discussion in your PR description.
93+
*Docs(GraphQL): Document the @deprecated annotation*
10094

10195
- **Technical writing style**: As much as possible, please follow technical writing style conventions (More on this below).
10296

@@ -134,19 +128,6 @@ docusaurus-docs/
134128
└── src/ # Custom components and styles
135129
```
136130

137-
## Testing
138-
139-
### Type Checking
140-
141-
Run TypeScript type checking:
142-
143-
```bash
144-
npm run typecheck
145-
```
146-
147-
### Link Checking
148-
149-
After building the site, you can check for broken links using external tools or by manually testing the built site.
150131

151132
## Runnable Code Examples
152133

0 commit comments

Comments
 (0)