-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Crates documentations guideline #9558
Open
tguichaoua
wants to merge
5
commits into
bevyengine:main
Choose a base branch
from
tguichaoua:docs-guidelines
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+57
−0
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
tguichaoua
changed the title
Cretes documentations guideline
Crates documentations guideline
Aug 24, 2023
This was referenced Aug 24, 2023
mockersf
reviewed
Aug 24, 2023
mockersf
reviewed
Aug 24, 2023
mockersf
reviewed
Aug 24, 2023
rparrett
added
C-Docs
An addition or correction to our documentation
A-Meta
About the project itself
labels
Aug 26, 2023
bas-ie
suggested changes
Sep 22, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just added a couple of suggestions per conversation on #9560.
Co-authored-by: Rich Churcher <[email protected]>
Co-authored-by: Rich Churcher <[email protected]>
tguichaoua
force-pushed
the
docs-guidelines
branch
from
September 23, 2024 08:03
a24a96b
to
6650188
Compare
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.
Objective
Solution
Add a
docs_guide.md
in.github/contributing
with the points discussed in #9500.