alphagov / alphagov/tech-docs-gem
[Bug]: select_top_level_html_files ignoring custom http_prefix
Open
Nobody has claimed this yet.
bug
- Dominant language
- Ruby
- Stars
- 16
- Forks
- 47
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 14
Description
tech-docs-gem version
This is an issue to keep track of
- #438
- #84
- #79
ruby version
all
What happened?
https://github.com/alphagov/tech-docs-template/issues/183#issuecomment-478942982
Steps to reproduce
https://github.com/alphagov/tech-docs-template/issues/183#issuecomment-478942982
Logs or error output
No response
Checks
- I have searched for existing issues
- I have checked other users also have this issue
- I have checked that I am not using a local or forked repository with untested changes
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the select_top_level_html_files implementation in the Ruby gem and read the reproduction details in the linked tech-docs-template issue comment. Confirm how a custom http_prefix is handled and define completion as selecting the expected top-level HTML files when that prefix is configured.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100