docs: Documenting how to write documentation #1721
Merged
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
Co-authored-by: Lukas Klingsbo <[email protected]>
luanpotter
reviewed
Jun 14, 2022
luanpotter
reviewed
Jun 14, 2022
| @@ -0,0 +1,5 @@ | |||
| # Development | |||
There was a problem hiding this comment.
would Contributing be a better name? development could refer to game development in general
There was a problem hiding this comment.
On that topic; it would be nice to include the CONTRIBUTING.md file in this category too.
There was a problem hiding this comment.
Yes, we could eventually publish a variety of things here, such as
- the main "contributing" guideline;
- various policies;
- schedule of future releases, and/or events (such as FlameCons);
- mirror of the changelog, so that it is easier to find;
- etc.
The term "development" seem to be more generic and capable of fitting more topics.
There was a problem hiding this comment.
I think development is fine as a topic, since contributing should refer to the specific contributing.md doc.
st-pasha
added a commit
to st-pasha/flame
that referenced
this pull request
Jun 18, 2022
Since our documentation is fairly complex, we need to have a document which describes how various parts of it work. This PR adds such documentation.
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.
Description
Since our documentation is fairly complex, we need to have a document which describes how various parts of it work. This PR adds such documentation.
Checklist
fix:,feat:,docs:etc).docsand added dartdoc comments with///.examples.Breaking Change
Related Issues