Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate guidelines folder into documentation #4731

Merged
merged 12 commits into from
Dec 4, 2024

Conversation

KrystalDelusion
Copy link
Member

@KrystalDelusion KrystalDelusion commented Nov 12, 2024

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.

  • Checklists
  • CodeOfConduct
  • CodingStyle
  • UnitTests
  • Windows
  • Readme changes
  • Remaining TODOs in getting_started/installation.rst

Left for the future:

  • GettingStarted
  • Contributing page

If applicable, please suggest to reviewers how they can test the change.
Preview build
Readme etc on github

@KrystalDelusion KrystalDelusion marked this pull request as ready for review December 1, 2024 22:34
@KrystalDelusion KrystalDelusion force-pushed the docs-preview-noguidelines branch from f2dcd8e to b137334 Compare December 3, 2024 00:16
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 KrystalDelusion force-pushed the docs-preview-noguidelines branch from d383d79 to 40af327 Compare December 4, 2024 20:21
@KrystalDelusion KrystalDelusion merged commit 4418f92 into main Dec 4, 2024
44 checks passed
@KrystalDelusion KrystalDelusion deleted the docs-preview-noguidelines branch December 4, 2024 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants