Skip to content

fix: update documentation for indentations #401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

cyrng
Copy link
Contributor

@cyrng cyrng commented Feb 11, 2025

What does this PR do ?

It changes the wrong indentations applied for editor hints documents and add javascript example.

image

How should this be manually tested?

  • Step 1 : Open the preview of index at /doc/2/concepts/metadatadetails/index.md
  • Step 2 : Import the index in the kuzzle documentation app and run kuzdoc dev
  • Step 3 : Check if there no longer indentations

Other changes

Boyscout

Highlight some info in Editor hints section and format some tags html

@cyrng cyrng self-assigned this Feb 11, 2025
Copy link
Member

@etrousset etrousset left a comment

Choose a reason for hiding this comment

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

Les enum TS devraient être remplacé par leur valeur String dans les exemples d'appel à l'API, on peux documenter les Enum TS à côté pour la doc developpeurs

@cyrng cyrng requested a review from etrousset February 11, 2025 11:01
Copy link
Member

@etrousset etrousset left a comment

Choose a reason for hiding this comment

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

The TS ENUM could be documented is spécific section

@etrousset
Copy link
Member

Also, the tables descripbing the parameter should use the same styling as the documentation has here: https://docs.kuzzle.io/core/2/api/payloads/request/

@cyrng cyrng requested a review from etrousset February 12, 2025 09:23
@etrousset etrousset merged commit fdd758e into 2-dev Feb 12, 2025
11 checks passed
@etrousset etrousset deleted the KZLPRD-794-la-documentation-d-api-pour-le-setup-dun-editor-hint-dans-les-models-dassets-montre-un-exemple-en-js-au-lieux-du-json branch February 12, 2025 15:46
github-actions bot pushed a commit that referenced this pull request Feb 12, 2025
## [2.8.0-dev.3](v2.8.0-dev.2...v2.8.0-dev.3) (2025-02-12)

### Bug Fixes

* update documentation for indentations ([#401](#401)) ([fdd758e](fdd758e))
github-actions bot pushed a commit that referenced this pull request Mar 5, 2025
## [2.8.0-beta.1](v2.7.2...v2.8.0-beta.1) (2025-03-05)

### Features

* **assetsGroups:** add service to handle groups related actions in a way that triggers pipe like devices and assets ([1a43fe7](1a43fe7))
* **deviceManagerEngine:** free devices after engine deletion ([#382](#382)) ([7c32f9f](7c32f9f))
* **groupmodels:** add possibility to set up group models with metadatas ([#392](#392)) ([19b2b70](19b2b70))
* measures should not be historized on asset ([#404](#404)) ([6a73786](6a73786))
* update measure model for localization ([#385](#385)) ([429678f](429678f))

### Bug Fixes

* clean on detach ([#400](#400)) ([cb8badf](cb8badf))
* last measured at ([#399](#399)) ([07830c0](07830c0))
* update documentation for indentations ([#401](#401)) ([fdd758e](fdd758e))
github-actions bot pushed a commit that referenced this pull request May 13, 2025
## [2.8.0](v2.7.2...v2.8.0) (2025-05-13)

### Features

* **assetsGroups:** add service to handle groups related actions in a way that triggers pipe like devices and assets ([1a43fe7](1a43fe7))
* **deviceManagerEngine:** free devices after engine deletion ([#382](#382)) ([7c32f9f](7c32f9f))
* **groupmodels:** add possibility to set up group models with metadatas ([#392](#392)) ([19b2b70](19b2b70))
* measures should not be historized on asset ([#404](#404)) ([6a73786](6a73786))
* update measure model for localization ([#385](#385)) ([429678f](429678f))

### Bug Fixes

* clean on detach ([#400](#400)) ([cb8badf](cb8badf))
* last measured at ([#399](#399)) ([07830c0](07830c0))
* update documentation for indentations ([#401](#401)) ([fdd758e](fdd758e))
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.

2 participants