lenra-io / lenra-io/docs

[Task] Add the Lenra app OpenAPI reference to the documentation website

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

Nobody has claimed this yet.

documentation enhancement good first issue
Dominant language
CSS
Stars
5
Forks
0
PR merge metrics
No merged PRs in 30d

Description

What should be done

Add the Lenra app OpenAPI reference to the documentation website

Create a new page with a link to the swagger editor (https://editor-next.swagger.io/) and the API URL from the latest release of the API project: https://github.com/lenra-io/api/releases

Is this task linked with any other ?

Blocked by https://github.com/lenra-io/api/issues/7

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.

Research direction

Start by reviewing the documentation website's existing page structure and the API project's latest release at https://github.com/lenra-io/api/releases. Add a new page linking to https://editor-next.swagger.io/ and the release's API URL; the task is done when the OpenAPI reference is available from the documentation website.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.