Skip to content

Conversation

@SyedaLamiaTabassum
Copy link

@SyedaLamiaTabassum SyedaLamiaTabassum commented Sep 10, 2025

Description

new role of observer-access has been added that will provide read only access to specified user.

Type of change

  • Documentation (update or new)

Checklist

  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have updated astro.config.mjs
  • I have requested peer junior and senior review on this PR

@netlify
Copy link

netlify bot commented Sep 10, 2025

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit d697fba
🔍 Latest deploy log https://app.netlify.com/projects/ontrackdocumentation/deploys/68c7e5da726fa900084b9773
😎 Deploy Preview https://deploy-preview-54--ontrackdocumentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@lachlan-robinson lachlan-robinson left a comment

Choose a reason for hiding this comment

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

Hi @SyedaLamiaTabassum, well done on this documentation task.

Well done:

  • The documentation clearly explains the purpose and implementation of the Observer role, including its read-only policy.
  • Sections are logically organized: Overview, Implementation, Database Changes, Code Logic, Unit Tests, and Conclusion.
  • Code snippets for migration, authorization logic, and unit tests are provided, making it easy for developers to understand and replicate.

Consider changes:

  • Minor typos (e.g., "utfmb3" should be "utf8mb3")—ensure terminology matches actual code/database settings.
  • Consider using bullet points or numbered lists for steps and actions for easier readability.

This documentation is thorough and professional, providing all necessary details for understanding and maintaining the Observer role in the Doubtfire API. Minor formatting and consistency improvements could further enhance clarity.

Copy link
Contributor

@lachlan-robinson lachlan-robinson left a comment

Choose a reason for hiding this comment

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

Well done on implementing the requested changes to the documentation. However,

  • Your PR is not currently passing the automated build actions.

Make sure that:

  • You have branched from the latest main branch that does not have build errors.
  • You have tested your doubtfire-astro branch locally using npm start to ensure it builds without errors.

@SyedaLamiaTabassum
Copy link
Author

Well done on implementing the requested changes to the documentation. However,

  • Your PR is not currently passing the automated build actions.

Make sure that:

  • You have branched from the latest main branch that does not have build errors.
  • You have tested your doubtfire-astro branch locally using npm start to ensure it builds without errors.

Hello, I have tested my branch locally and the build is working now,

Copy link

@WaelAlahamdi WaelAlahamdi left a comment

Choose a reason for hiding this comment

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

Hi @SyedaLamiaTabassum, I have reviewed the documentation and found no issues. Everything looks clear and well-structured. Thank you for the work.

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