📚 Documentation: App class documentation is not up to date

Open
#91 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
php
Domain
documentation

Research direction

Compare README.md and Getting-Starting-Guide.md with the current App class behavior, focusing on the documented hook types and init parameters. Update both documents so they describe the current API accurately, then verify that the outdated three-hook and parameter descriptions are gone.

Written by the indexing model from the issue text.

Description

💭 Description

Both the README.md file and the Getting-Starting-Guide.md file suggests that there are 3 types of hooks, and that the parameters for the init hook for example are a callback function, a resources array, and a group.

However, this has not been the case for the past 2 years.

Documentation should be updated.

👀 Have you spent some time to check if this issue has been raised before?
  • I checked and didn't find similar issue
🏢 Have you read the Code of Conduct?
Dominant language
PHP
Stars
297
Forks
34
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from utopia-php/http

All issues in utopia-php/http

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.