Skip to content

Commit ccb62c4

Browse files
committed
Update PR guidance regarding docs
Signed-off-by: Ben Howe <bhowe@nvidia.com>
1 parent 6005448 commit ccb62c4

2 files changed

Lines changed: 0 additions & 13 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,6 @@ through and explain.
4848
- [ ] Public-facing APIs have Doxygen docs.
4949
- [ ] User-visible behavior changes have public docs, or a follow-up is
5050
tracked.
51-
- [ ] User-facing docs for new features are in a **separate PR** held until
52-
release (the docs site publishes immediately on merge to the default
53-
branch, so feature docs must not land before the feature ships).
5451

5552
### Code style
5653
- [ ] Naming follows the existing convention (`snake_case` vs `camelCase`) for

Contributing.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -85,16 +85,6 @@ this section is the authoritative source.
8585
required.
8686
- If public docs were not created for a user-visible change, **report and track
8787
that they still need to be written.**
88-
- **Docs for new features go in a separate PR, held until release.** Our
89-
published documentation site updates immediately when changes land on the
90-
default branch, so user-facing docs that describe a feature must not be
91-
merged before the feature is actually available in a release. The
92-
recommended flow is:
93-
1. Merge the code change (with Doxygen / API reference updates only).
94-
2. Open a follow-up PR that adds the user-facing docs (guides, tutorials,
95-
release notes, examples).
96-
3. Keep that docs PR in Draft / on hold and merge it at release time so
97-
the published site and the released bits go live together.
9888

9989
### Code style
10090

0 commit comments

Comments
 (0)