Add developer docs #3097
Merged
Add developer docs #3097
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
|
I finally had some time to go through it. I just have one comment. Considering that the |
|
@mmahmoudian Ah yes. I used this file as a temporary file where I would write documentation brainstorms. I accidentally committed it - and I will remove it now. (There are still some things from that file that need to be added to the proper documentation, but I'll do that another time). |
panpuchkov
pushed a commit
to namecheap/flameshot
that referenced
this pull request
Dec 22, 2023
* Create developer docs * Remove mike dependency * Update docs * Make docs/dev self-contained * Add incomplete deploy-dev-docs workflow * Fix typo * Add workflow file to path: * Add doxygen as dependency * Add remaining deploy steps * Add working-directory * Fix working-directory error * Add missing Makefile * Change flameshot website repo url * Change working-directory for safety step * Add git credentials * Change push credentials * Use different token secret * Remove checkpoints * Add separate branch developer-docs * Add || true * Update docs * Update the 'Maintaining the documentation' docs * Fix error in deploy-dev-docs workflow * Remove accidentally committed file DOC.md * Update PAT expiry date * Rename developer-docs branch to dev-docs-staging (cherry picked from commit a2f036b)
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.
Adds developer docs, including documentation generated from code comments using doxygen.
The documentation itself is not complete, but please do read it if you find the time and make suggestions what can be improved or added.
@mmahmoudian Especially read the 'Maintaining the documentation' section so you know how the documentation is deployed and maintained.
The docs are live here: https://flameshot.org/docs/dev