firebase / firebase/firebase-admin-java

FR: Source maps for docs

Open
#41 0 comments 0 reactions 0 assignees View on GitHub
type: feature request
Dominant language
Java
Stars
620
Forks
305
Avg merge
3h 23m
Merged PRs (30d)
1

Description

Add a source map to the doc generation process so that reference docs can link directly into source files for each function/constant/etc.

Contributor guide

Open the contributing guide

Research direction

Start by locating the documentation generation process in the repository and inspect how reference docs are produced for functions and constants. Determine where a source map would be emitted and how generated links should point into source files. Done means reference documentation links directly to the corresponding source locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
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.