Create docs/ folder #1832
Merged
Create docs/ folder #1832
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
alexeagle
force-pushed
the
docs
branch
7 times, most recently
from
97ef0df to
6c3cbb6
Compare
|
It'd be great if the docs directory was a separate workspace which doubled as a visibility test. |
gravypod
reviewed
Apr 28, 2021
README.md
Outdated
| </tr> | ||
| </tbody> | ||
| </table> | ||
| **MOVED**: See generated API documentation in docs/image.md |
There was a problem hiding this comment.
Can we make docs/image.md a link?
gravypod
approved these changes
Apr 28, 2021
This documentation is now generated from sources rather than hand-maintained in markdown/HTML. Move the existing starlark target there, and check in the generated output. Uses generated_file_test since that prints the bazel run command to accept the new file, making this workflow easy for novice contributors to follow. Also don't make users install the stardoc repository anymore, now that they don't load() from this BUILD file they shouldn't need it.
martaver
pushed a commit
to cleric-sh/rules_docker
that referenced
this pull request
May 18, 2021
…zelbuild#1832) This documentation is now generated from sources rather than hand-maintained in markdown/HTML. Move the existing starlark target there, and check in the generated output. Uses generated_file_test since that prints the bazel run command to accept the new file, making this workflow easy for novice contributors to follow. Also don't make users install the stardoc repository anymore, now that they don't load() from this BUILD file they shouldn't need it.
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.
Move the existing starlark target there, and check in the generated output.
Uses generated_file_test since that prints the bazel run command to accept the new file,
making this workflow easy for novice contributors to follow.
Also don't make users install the stardoc repository anymore, now that they don't load() from this BUILD file they shouldn't need it.