Add documentation website #111
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
|
This will currently cause the link check CI to fail due to this repo and the arduino/arduino-lint-action repo being private. So merging should probably wait. But it is in a finished state ready for review. I will add the installation instructions and related links in a subsequent PR. |
per1234
commented
Dec 16, 2020
per1234
force-pushed
the
per1234/docs
branch
from
3a6c1d6 to
b1ccd08
Compare
|
The failure of the "Lint configuration files" workflow is expected and unrelated to the changes proposed in this PR. It will be fixed by #114 |
per1234
force-pushed
the
per1234/docs
branch
2 times, most recently
from
0425586 to
fba789e
Compare
A static website containing documentation is hosted on GitHub Pages. The source is the Markdown files stored in the `docs` subfolder, as well as the CLI documentation generated by Cobra. The documentation is versioned, so the user can access the documentation associated with: - The development version (tip of the default branch). - The latest release version. - Any specific release version.
Python-Markdown extensions are used to provide additional capabilities to the documentation website generation. Because Python-Markdown is extremely faithful to the original Markdown specification, despite the fact that the world has moved on to a more capable implementation, some extensions are essential to provide the Markdown capability the documentation editors will expect. However, some additional extenstions were added to the Arduino CLI MkDocs configuration which provide syntax not supported by any Markdown implementation, and which are not needed. If we later find the pressing need for such capability, we can add in the necessary extensions. Until then, having these extensions could result in unexpected behavior.
This file is exclusive to the documentation, so there is no point in it being in the already crowded root of the repo.
Poetry is already in use for the integration testing code, so it makes sense to use it with all Python code in the repository.
per1234
force-pushed
the
per1234/docs
branch
from
fba789e to
0f55d25
Compare
silvanocerza
approved these changes
Dec 18, 2020
per1234
added
topic: 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.
A static website containing documentation is hosted on GitHub Pages. The source is the Markdown files stored in the
docssubfolder, as well as the CLI documentation generated by Cobra.The documentation is versioned, so the user can access the documentation associated with:
Documentation website demo: https://per1234.github.io/arduino-lint/latest/