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

docs: Some documentation improvements around online/offline behaviour. #333

Merged
merged 4 commits into from
Oct 22, 2024

Conversation

TheRealAgentK
Copy link
Contributor

docs: Documentation improvements around online/offline behaviour.

Description 📝

  • Some documentation improvements around online/offline behaviour.
  • Changes stem from me actually trying to use the online/offline feature.

Type of change

  • This change requires a documentation update

Updates

👉 Documentation update for now
👉 We might want to consider additional changes around when and how cached reports are being sent to RG, but that might be a future issue.

Author to check 👓

  • Appropriate documentation written (code comments, internal docs)

Reviewer to check ✔️

  • Project and all contained modules builds successfully
  • Change has been dev-/reviewer-tested, where possible
  • Unit/UI/Automation/Integration tests provided where applicable
  • Code is written to standards
  • Appropriate documentation written (code comments, internal docs)

@miquelbeltran
Copy link
Contributor

Following up with the chat on Slack, there are few things that need to be clarified in the README.

  1. that isOffline must be set to true to enable the offline support.
  2. The example setting up offline support should have isOffline: true.

@TheRealAgentK
Copy link
Contributor Author

Following up with the chat on Slack, there are few things that need to be clarified in the README.

  1. that isOffline must be set to true to enable the offline support.
  2. The example setting up offline support should have isOffline: true.

Ok, leave it with me, I'll fix the doc.

Copy link
Collaborator

@sumitramanga sumitramanga left a comment

Choose a reason for hiding this comment

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

Changes look good so far, I agree with Miguel on his feedback!

@TheRealAgentK
Copy link
Contributor Author

Changes look good so far, I agree with Miguel on his feedback!

@miquelbeltran @sumitramanga Made some additional adjustments, if you're happy with it them, just merge them in.

README.md Outdated Show resolved Hide resolved
Change suggested by @sumitramanga
Another tweak.
@TheRealAgentK TheRealAgentK merged commit aa54966 into develop Oct 22, 2024
5 checks passed
@sumitramanga
Copy link
Collaborator

Discussed offline - Kai has made the tweak and merged

@sumitramanga sumitramanga deleted the feature/documentation-offline branch December 3, 2024 03:12
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.

3 participants