gavinlaking / vedeu

A framework written in Ruby for building GUI/TUI terminal/console applications.
Other
577 stars 35 forks source link

Docbug: interface.md does not exist (404) #393

Closed ghost closed 1 year ago

ghost commented 6 years ago

I was reading Vedeu's documentation and I clicked on the "Interface" link provided in https://www.rubydoc.info/gems/vedeu/file/docs/borders.md. It returned RubyDoc's 404 page. I also checked it with cURL:

➜ ~ curl -Is https://www.rubydoc.info/gems/vedeu/file/docs/interface.md | head -n 1
HTTP/1.1 404 Not Found

So I looked through the docs/ directory and found out that the file name is actually interfaces.md, not interface.md.

borders.md is not the only file with this problem. By running

Dir.glob("**/*.md") { |f| puts f if File.read(f).include?("file:docs/interface.md") }

in docs/, I found out all files which reference interface.md. The files are:

I thought of two solutions:

I will open a pull request with the latter solution.