Integrate guidelines folder into documentation #4731
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
nakengelhardt
approved these changes
Dec 2, 2024
Disable the export to docs and remove any references to the guidelines folder.
Drop the parts that are being dropped. Move the things that are being moved. Also move the verilog stuff out of README and into the docs. GettingStarted is less cut and dry, so hold off on that one.
Based on version 2.0 of the Contributor Covenant.
Github shows the license file automatically, and the first section mentions it is ISC.
Also drop visual studio instructions.
Update FreeBSD line to include CXX as well as CC. Drop unneeded todo.
Add warning for Cygwin. Add commented out instructions for MSYS2 that I tried to get to work but ran into build errors.
KrystalDelusion
force-pushed
the
docs-preview-noguidelines
branch
from
f2dcd8e
to
b137334
Compare
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.
What are the reasons/motivation for this change?
Everything in the guidelines folder should either be in the root folder, and picked up by github, or in the documentation proper.
Explain how this is achieved.
Move the stuff where it should be instead. Fill out/update the parts that are missing/out of date.
Left for the future:
If applicable, please suggest to reviewers how they can test the change.
Preview build
Readme etc on github