This repository was archived by the owner on Sep 3, 2025. It is now read-only.
Add technical documentation #44
Merged
Conversation
This file contains hidden or 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
vdye
force-pushed
the
vdye/technical-diagrams
branch
from
b7ed924 to
2f6016b
Compare
ldennington
approved these changes
Apr 25, 2023
Collaborator
ldennington
left a comment
ldennington
left a comment
There was a problem hiding this comment.
Great stuff! I think this is going to be so helpful for new contributors when we open source!
derrickstolee
approved these changes
Apr 25, 2023
Collaborator
derrickstolee
left a comment
derrickstolee
left a comment
There was a problem hiding this comment.
I have a few suggestions that might improve things, but these are a really strong documents already.
Add basic API documentation for the web server's endpoints, including a disclaimer about backward compatibility (or lack thereof). Also, update the VSCode Markdown settings to use spaces rather than tabs for indentation (to allow for cleaner sub-tab length alignment here and in future patches). Signed-off-by: Victoria Dye <[email protected]>
Add a high-level representation of the bundle server architecture, including descriptions of the major components of a bundle server. Helped-by: Derrick Stolee <[email protected]> Signed-off-by: Victoria Dye <[email protected]>
vdye
force-pushed
the
vdye/technical-diagrams
branch
4 times, most recently
from
f485740 to
cbddee1
Compare
Add flowcharts documenting how the bundle URI feature in Git downloads from the bundle server. Co-authored-by: Derrick Stolee <[email protected]> Signed-off-by: Victoria Dye <[email protected]>
vdye
force-pushed
the
vdye/technical-diagrams
branch
from
cbddee1 to
d98e9c9
Compare
derrickstolee
approved these changes
Apr 26, 2023
vdye
added a commit
that referenced
this pull request
Apr 26, 2023
Minor fixups from #44 (for tech docs & VSCode settings)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add technical documentation for the bundle server:
git-bundle-web-server.