Skip to content

Outdated documentation on generated documentation #18724

@nijel

Description

@nijel

Describe the issue

The recently introduced automatically generated documentation snippets are not covered in https://docs.weblate.org/en/latest/contributing/documentation.html#documenting-permissions-checks-add-ons-and-automatic-suggestions.

What is missing:

  • How to add new sections? For example, with add-ons the newly added sections are automatically placed in wrong location (after parameters and outdated add-ons).

I already tried

  • I've read and searched the documentation.
  • I've searched for similar filed issues in this repository.

Steps to reproduce the behavior

  1. Contributor creates Add ObjCFormatCheck for Objective-C format strings #18590
  2. The documentation is written manually

Expected behavior

  • The CI should add missing documentation
  • The documentation should clearly describe how to do that locally and what edits are allowed .

Screenshots

No response

Exception traceback

How do you run Weblate?

No response

Weblate versions

No response

Weblate deploy checks

Additional context

No response

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to the documentation.

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions