lenra-io / lenra-io/docs

[Task] Add a compiled & compressed release to download the full doc and use it offline

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

Nobody has claimed this yet.

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

Description

What should be done

Add in the CI a build/compress and release of the documentation. The goal is to download it and use if completely offline.

Technical recommandation

Simply use the CI and any necessary actions, it should not be too hard :)

Ecological concerns

Try to only add a minified code & compress it to make it as small as possible !

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 locating the existing documentation build and CI workflow, then identify the entry point that produces the full documentation. Run that build locally or through CI and determine how a compressed, downloadable release can be verified for complete offline use; done means the artifact is released and usable without network access.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.