Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ syntax, see the documentation at the top of
## Admin reports

There are several types of data reports available to superusers.

* Full list of users including their details provided during signup, number of deployed projects (XForm count), number of submissions, date joined, and last login: `<kpi base url>/superuser_stats/user_report/`. File being created is a CSV, so don't download immediately to wait for server to be finished writing to the file (it will download even if incomplete).
* Monthly aggregate figures for number of forms, deployed projects, and submissions (from kobocat): `<kc server domain>/<superuser username>/superuser_stats/`

Expand All @@ -73,8 +74,14 @@ See [browsers list config](./.browserslistrc)

The OpenAPI documentation is available at:

- **Swagger UI**: [`/api/v2/docs/`](https://kf.kobotoolbox.org/api/v2/docs/)
- **Raw schema**: [`/api/v2/schema/`](https://kf.kobotoolbox.org/api/v2/schema/)
* **Swagger UI**: [`/api/v2/docs/`](https://kf.kobotoolbox.org/api/v2/docs/)
* **Raw schema**: [`/api/v2/schema/`](https://kf.kobotoolbox.org/api/v2/schema/)
Comment on lines +77 to +78

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 PR title does not follow the required format

The template requires <type>(<scope>)<!>: <title> DEV-1234 (e.g. docs: update README with Greptile test notes DEV-0000). The current title wip: test greptile ignore behavior omits the scope, the optional breaking-change marker, and the ticket reference. The checklist also calls for assigning yourself and tagging the PR with at least one of Front end, Back end, or workflow.

Rule Used: What: PR descriptions must follow the repository's... (source)

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


For details about how the API documentation is implemented in each Django app,
Comment on lines 74 to 80

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 PR description missing required template sections

The template requires ### 📣 Summary, ### 📖 Description, and ### 👷 Description for instance maintainers sections (delete only if explicitly not applicable). The current description skips all three and jumps straight to ### 💭 Notes. The preview steps in the description (steps 3–7) also appear to be copied verbatim from the template placeholders rather than describing actual reproduction steps for this change.

Rule Used: What: PR descriptions must follow the repository's... (source)

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

see [`./docs/README`](./docs/README).

***

Hello Greptile! :wave:
Comment on lines 80 to +85

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 This block — a horizontal rule plus "Hello Greptile! 👋" — is a test artifact from the experiment described in the PR and has no place in the project's README. Merging this would pollute production documentation with noise.

Suggested change
For details about how the API documentation is implemented in each Django app,
see [`./docs/README`](./docs/README).
***
Hello Greptile! :wave:
For details about how the API documentation is implemented in each Django app,
see [`./docs/README`](./docs/README).

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


This is the fourth commit.