jakartaee / jakartaee/cdi

Live view of documents (javadoc, spec)

Open
#665 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
240
Forks
83
PR merge metrics
No merged PRs in 30d

Description

Is it possible to set up something like netlify to have live previews of PRs and current version of the specification?
I know everyone can of course checkout the repo and build the documents.
I'm also awayre that markdown/asciidoc allows to easily review PRs, but there links involved and it's sometimes hard to know which part we are refering too.

Contributor guide

Open the contributing guide

Research direction

Start by checking how the repository currently builds its documents and how the markdown/asciidoc specification sources are organized. Define what previewing a pull request and the current specification should expose, then determine whether a live preview setup can support both workflows.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
devops, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.