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

Open
wants to merge 5 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.

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
@Rot127 Rot127 marked this pull request as ready for review May 30, 2024 08:42
Copy link
Contributor

@XVilka XVilka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@numas13 you might be interested in quickly skimming through these documents as well.

suite/auto-sync/ARCHITECTURE.md Outdated Show resolved Hide resolved
suite/auto-sync/README.md Outdated Show resolved Hide resolved
suite/auto-sync/README.md Outdated Show resolved Hide resolved
suite/auto-sync/README.md Outdated Show resolved Hide resolved
suite/auto-sync/intro.md Outdated Show resolved Hide resolved
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

2 participants