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

Restructure auto-sync docs to have them more contained #2355

Draft
wants to merge 4 commits into
base: next
Choose a base branch
from

Conversation

Rot127
Copy link
Collaborator

@Rot127 Rot127 commented May 11, 2024

Your checklist for this pull request

  • I've documented or updated the documentation of every API function and struct this PR changes.
  • I've added tests that prove my fix is effective or that my feature works (if possible)

Detailed description

The auto-sync documentation was spread around and confusing. This is an attempt to move it closer together and remove duplicate (and contradicting) instructions.

Todo

  • Add a section about "Why we need actually auto-sync". Possibly take it from the blog post.
  • A Link to (archived) blog post for deep dives
  • Extend the main ARCHITECTURE.md for the Capstone section
    • A Link it on the main README and make it clear that it is a "must" first read for any developer.
  • Add tldr version about TableGen from the blog post somewhere.

Test plan

...

Closing issues

...

@github-actions github-actions bot added the auto-sync-files auto-sync label May 11, 2024
@Rot127 Rot127 marked this pull request as draft May 11, 2024 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant