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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

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
  • GettingStarted
  • UnitTests
  • Windows
  • Readme changes part 1
  • Readme changes part 2
  • Contributing page

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

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.
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.

1 participant