Skip to content

docs: Add a user guide#263

Merged
nj1973 merged 27 commits into
mainfrom
211-user-guide
Jun 2, 2026
Merged

docs: Add a user guide#263
nj1973 merged 27 commits into
mainfrom
211-user-guide

Conversation

@nj1973
Copy link
Copy Markdown
Collaborator

@nj1973 nj1973 commented May 19, 2026

The PR adds a user guide for Offload. The content is mostly content from the original Offload utility with redundant sections removed.

@nj1973 nj1973 linked an issue May 19, 2026 that may be closed by this pull request
@nj1973 nj1973 requested a review from abb9979 May 22, 2026 10:13
@nj1973 nj1973 marked this pull request as ready for review May 22, 2026 10:13
Copy link
Copy Markdown
Contributor

@abb9979 abb9979 left a comment

Choose a reason for hiding this comment

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

Fully reviewed. Some common themes you'll see:

  1. Formatting keywords, technical words, data types etc. A consistency sweep needed as per the ones I call out in the comments.
  2. Probably one to discuss, but it seems as though we should simply remove all of the references to anything that's not BigQuery as the backend.

Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Comment thread docs/user_guide.md Outdated
Copy link
Copy Markdown
Contributor

@abb9979 abb9979 left a comment

Choose a reason for hiding this comment

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

Reviewed GCP setup guide.

Comment thread docs/gcp_setup.md Outdated
Comment thread docs/gcp_setup.md
Comment thread docs/gcp_setup.md Outdated
Comment thread docs/gcp_setup.md Outdated
@nj1973
Copy link
Copy Markdown
Collaborator Author

nj1973 commented May 29, 2026

I think I've responded to all comments

Copy link
Copy Markdown
Contributor

@abb9979 abb9979 left a comment

Choose a reason for hiding this comment

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

Final comment.

Comment thread docs/user_guide.md Outdated
Copy link
Copy Markdown
Contributor

@abb9979 abb9979 left a comment

Choose a reason for hiding this comment

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

LGTM! Excellent to have this documentation in the repo.

@nj1973 nj1973 merged commit e525f28 into main Jun 2, 2026
8 checks passed
@nj1973 nj1973 deleted the 211-user-guide branch June 2, 2026 11:47
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.

User Guide

2 participants