Skip to content

Conversation

@samindiii
Copy link

@samindiii samindiii commented May 18, 2025

Description

This update includes:

  • Markdown documentation for the GrantExtensionFormComponent and dialog.
  • Example API payloads and responses.
  • Description of UI behavior and form validation logic.

Additionally, added a front-end component list page to match the backend API page.
Fixes # (issue)

Type of change

  • Documentation (update or new)

How Has This Been Tested?

I tested this by

  1. Run npm install
  2. Run npm run dev
  3. Navigate to the front end documentation and test that it works + reads well
  4. Navigate to the back end documentation and test that it works + reads well
  5. Additionally checked the structure

Alternatively, visit the deploy preview link (https://deploy-preview-40--ontrackdocumentation.netlify.app/) and navigate to documentation/front_end/staff_grant extension and documentation/backend/api/staff_grant_extension.

Testing Checklist

  • Tested in latest Chrome
  • Tested in latest Safari
  • Tested in latest Firefox

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • 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 requested a review from ... on the Pull Request

@netlify
Copy link

netlify bot commented May 18, 2025

Deploy Preview for ontrackdocumentation failed.

Name Link
🔨 Latest commit 6fa5084
🔍 Latest deploy log https://app.netlify.com/projects/ontrackdocumentation/deploys/6898556caa59dc00089e069a

@returnMarcco
Copy link

returnMarcco commented May 19, 2025

Hi @samindiii ,

I'll be completing a junior peer review for your documentation changes.

To review this, I've accessed the preview of the documentation via Netlify.

Frontend Documentation Review

  • The document is well formatted
  • The document is structured logically
  • Grammar is correct
  • The component overview sufficiently explains the purpose of the component
  • The expected behavior of the component is sufficiently detailed
  • Data types handled by the component are clearly detailed in the document
  • The usage table clearly describes the required and optional user input for the component to function correctly

Overall, well done. I approve of these changes. The only suggestion I have is to include the type of data returned from the backend, so that it's clear how to handle the response from the server.

Backend Documentation Review

  • The document is well formatted
  • The document is structured logically
  • The overview of the endpoint clearly explains its purpose
  • The paramater table clearly describes the required and optional inputs
  • The response structure is clearly described

Well done. The only suggestion I have is to amend the grammar, looking for places that need full stops, etc. I approve these changes.

Copy link

@returnMarcco returnMarcco left a comment

Choose a reason for hiding this comment

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

I've left a review in the conversation section of the PR.

@sodabottlebaby
Copy link

Hi @samindiii,

I've reviewed the documentation, I accessed the preview via Netlify.

Frontend Documentation

  • The document is well-formatted, use proper grammar and well-explained
  • The document clearly explains the purpose and the intended behaviour of the component
  • Tables are used and formatted for clear reading and the sample usage table gives more explanation on how the component should work
  • Examples are included for better understanding

Overall, the front end documentation looks good to me!


Backend Documentation

  • The document is well-formatted and well-explained
  • The document clearly explains how the operation works, with relevant use of tables and examples for better understanding
  • The only thing I have to suggest is to include full stops where needed so the document looks neater.

Overall, the backend documentation looks good to me! Well done :)

I approve these changes.

@samindiii samindiii force-pushed the update-staff-grant-extension-docs branch 2 times, most recently from 32b11aa to 74d47f3 Compare August 10, 2025 08:14
@samindiii samindiii force-pushed the update-staff-grant-extension-docs branch from 74d47f3 to 6fa5084 Compare August 10, 2025 08:16
@samindiii
Copy link
Author

I'll update this PR again at the end of the trimester once the staff grant extension feature is complete.

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.

4 participants