Skip to content

Api docs

ryanlong requested to merge api_docs into main

Created by: deepakduggirala

Description

Add documentation for API framework

Update docs site with these features

  • Search
  • Auto generate sidebar
  • Add edit button which opens the current page in GitHub
  • Add last edited timestamp to the page

Dockerize docs dev server (docker compose up -d docs)

Added a git pre-commit hook that can detect when docs have changed but are not built. It'll then build the docs and asks the user to commit the new changes.

Changes Made

  • No changes to application code have been made.

  • Feature added

  • Bug fixed

  • Code refactored

  • Tests changed

  • Documentation updated

  • Other changes: [describe]

Checklist

Before submitting this PR, please make sure that:

  • Your code passes linting and coding style checks.
  • Documentation has been updated to reflect the changes.
  • You have reviewed your own code and resolved any merge conflicts.
  • You have requested a review from at least one team member.
  • Any relevant issue(s) have been linked to this PR.

Additional Information

Add any other information or context that may be relevant to this PR. This can include potential impacts, known issues, or future work related to this change.

Merge request reports