Update Documentation #12
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
JacobKnightley
changed the base branch from
main
to
users/JacobKnightley/authentication_logging
JacobKnightley
force-pushed
the
users/JacobKnightley/documentation
branch
from
50dd755 to
e17ddab
Compare
JacobKnightley
force-pushed
the
users/JacobKnightley/authentication_logging
branch
from
9cd65ce to
8c86edf
Compare
JacobKnightley
force-pushed
the
users/JacobKnightley/documentation
branch
3 times, most recently
from
9c394f4 to
9fff8e6
Compare
JacobKnightley
changed the base branch from
users/JacobKnightley/authentication_logging
to
main
JacobKnightley
force-pushed
the
users/JacobKnightley/documentation
branch
from
9364c6b to
4838060
Compare
There was a problem hiding this comment.
Copilot reviewed 18 out of 33 changed files in this pull request and generated 3 comments.
Files not reviewed (15)
- .vscode/extensions.json: Language not supported
- .vscode/settings.json: Language not supported
- VERSION: Language not supported
- docs/Makefile: Language not supported
- docs/config/overrides/main.html: Language not supported
- docs/config/stylesheets/extra.css: Language not supported
- docs/make.bat: Language not supported
- docs/source/index.rst: Language not supported
- docs/source/modules.rst: Language not supported
- SUPPORT.md: Evaluated as low risk
- docs/source/conf.py: Evaluated as low risk
- docs/code_reference.md: Evaluated as low risk
- README.md: Evaluated as low risk
- docs/how_to/example.md: Evaluated as low risk
- docs/help.md: Evaluated as low risk
Comments suppressed due to low confidence (2)
docs/contribution.md:18
- The word 'PowerShell' should be capitalized consistently.
[PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell)
docs/contribution.md:37
- The text 'URL-of-your-forked-repository' should be enclosed in angle brackets.
git clone <URL-of-your-forked-repository>
added 2 commits
January 13, 2025 10:41
jmuziki
approved these changes
Jan 13, 2025
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.
This pull request includes several updates to improve the documentation, configuration, and settings for the project. The most important changes involve enhancing the documentation structure, updating VS Code settings, and modifying the README file.
Documentation Updates:
README.md: Revised the project overview, documentation links, and installation instructions. Removed outdated sections and added new badges.SUPPORT.md: Removed the support instructions, consolidating support information into the documentation.docs/Makefile: Removed the Sphinx documentation makefile.docs/changelog.md: Added a changelog to document version history and planned features.docs/contribution.md: Added a contribution guide with prerequisites, initial configuration steps, and contribution instructions.Configuration Updates:
.vscode/extensions.json: Added the "tamasfe.even-better-toml" extension for TOML file support..vscode/settings.json: Updated default formatter settings for various file types and added Prettier configuration. [1] [2] [3]Other Changes:
VERSION: Reset version number to 0.0.1.