Summary
Generated markdown for vendored Rails docs contains many local links to markdown files that are never emitted.
These are user-visible broken links in the final vendor/docs/rails output.
Reproduction
- Run
rake vendor:setup.
- Run
rake vendor:docs:rails.
- Open generated files in
vendor/docs/rails/.
- Follow local links that point into source-file-shaped paths such as
actionpack/lib/..._rb.md or repository README-shaped paths.
Examples
vendor/docs/rails/AbstractController/Caching/Fragments.md:30
- Emits:
../../actionpack/lib/abstract_controller/url_for_rb.md
vendor/docs/rails/AbstractController/UrlFor.md:5
- Emits:
../actionpack/lib/abstract_controller/url_for_rb.md
vendor/docs/rails/ActionCable/Connection/Base.md:105
- Emits:
../../actionpack/lib/action_dispatch/middleware/request_id_rb.md
vendor/docs/rails/ActiveJob/EnqueueAfterTransactionCommit/ActiveJobMethods.md:9
- Emits:
../../activejob/lib/active_job/enqueue_after_transaction_commit_rb.md
vendor/docs/rails/ActiveJob/QueueAdapters.md:19
- Emits:
../activejob/README_md.md
None of those targets exist in the generated vendored output tree.
Actual Result
The generated Rails docs contain broken local links to non-existent markdown files.
In a rendered-link audit of the current vendored output, I found 102 broken local links in vendor/docs/rails.
Expected Result
When a reference resolves to a generated page, the link should target that emitted markdown path.
When there is no generated page for the reference, the output should either:
- render plain text, or
- render some other valid non-broken representation.
Notes
This seems related to the older closed path/linking work in #9, but there are still unresolved path mappings in the current vendored Rails output.
Summary
Generated markdown for vendored Rails docs contains many local links to markdown files that are never emitted.
These are user-visible broken links in the final
vendor/docs/railsoutput.Reproduction
rake vendor:setup.rake vendor:docs:rails.vendor/docs/rails/.actionpack/lib/..._rb.mdor repository README-shaped paths.Examples
vendor/docs/rails/AbstractController/Caching/Fragments.md:30../../actionpack/lib/abstract_controller/url_for_rb.mdvendor/docs/rails/AbstractController/UrlFor.md:5../actionpack/lib/abstract_controller/url_for_rb.mdvendor/docs/rails/ActionCable/Connection/Base.md:105../../actionpack/lib/action_dispatch/middleware/request_id_rb.mdvendor/docs/rails/ActiveJob/EnqueueAfterTransactionCommit/ActiveJobMethods.md:9../../activejob/lib/active_job/enqueue_after_transaction_commit_rb.mdvendor/docs/rails/ActiveJob/QueueAdapters.md:19../activejob/README_md.mdNone of those targets exist in the generated vendored output tree.
Actual Result
The generated Rails docs contain broken local links to non-existent markdown files.
In a rendered-link audit of the current vendored output, I found
102broken local links invendor/docs/rails.Expected Result
When a reference resolves to a generated page, the link should target that emitted markdown path.
When there is no generated page for the reference, the output should either:
Notes
This seems related to the older closed path/linking work in #9, but there are still unresolved path mappings in the current vendored Rails output.