Documentation Site #730
Merged
Documentation Site #730
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
…tables to make their values cleaner in the documentation site. Went ahead and filled out empty rule descriptions to get rid of weird looking generated example names. Added a base level layout for the site which still needs work.
…tables to make their values cleaner in the documentation site. Went ahead and filled out empty rule descriptions to get rid of weird looking generated example names. Added a base level layout for the site which still needs work.
…d to add more to it around how adding a rule works, how options work, etc.
…looks like, though there are still some pieces that are lacking.
…way that would work and added an icon for the docs
pjkaufman
force-pushed
the
documentation-site
branch
from
7c1bddd
to
3fa4aac
Compare
…them properly grab additional information
pjkaufman
force-pushed
the
documentation-site
branch
from
c4cf437
to
385a4eb
Compare
|
Accidentally force pushed changes from an outdated version of the branch. Will need to undo that tomorrow. |
pjkaufman
force-pushed
the
documentation-site
branch
from
385a4eb
to
c4cf437
Compare
|
The branch should be back to the way it was. I will see about getting this merged this week. It likely will not go into full use until a week or so from getting merged. |
pjkaufman
commented
Jun 28, 2023
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.
Relates to #692
Relates to #581
The end goal of this change is to have a documentation site that holds information on how rules work, how to contribute to the Linter, and some other information on how to use the Linter. Right now I believe that the contributions and rules portions of the change is in place and ready. However the overview page is definitely lacking content.
Here are some screenshots of what the site looks like in it current state:
The disabling rules page:
The header rules documentation page:
Changes Made:
TODO: