micronaut-projects / micronaut-projects/micronaut-docs

Include directive for inner config property classes using $ fails

Open
#25 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
CSS
Stars
11
Forks
17
PR merge metrics
No merged PRs in 30d

Description

There are four places in the online user guide with errors like

`Unresolved directive in - include::/home/runner/work/micronaut-core/micronaut-core/build/generated/configurationProperties/io.micronaut.http.server.netty.types.files.FileTypeHandlerConfiguration$CacheControlConfiguration.adoc[]`

It appears to be due to the inner class syntax using $. Occurs in:

- `hostResolution.adoc` include::{includedir}configurationProperties/io.micronaut.http.server.HttpServerConfiguration$HostResolutionConfiguration.adoc[]
- `localeResolution.adoc` include::{includedir}configurationProperties/io.micronaut.http.server.HttpServerConfiguration$LocaleResolutionConfiguration.adoc[]
- `transfers.adoc` include::{includedir}configurationProperties/io.micronaut.http.server.netty.types.files.FileTypeHandlerConfiguration$CacheControlConfiguration.adoc[]
- `threadPools.adoc` include::{includedir}configurationProperties/io.micronaut.http.server.netty.configuration.NettyHttpServerConfiguration$Worker.adoc[]

Contributor guide

Open the contributing guide

Research direction

Start with hostResolution.adoc, localeResolution.adoc, transfers.adoc, and threadPools.adoc, then inspect how the generated configurationProperties includes are resolved during the documentation build. Confirm the four unresolved directives and determine how inner-class paths containing $ are handled; done means all four guide pages build without unresolved include errors.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.