Clicking How to Install link in the doc produces html instead of a rendered page.

aplteam / Fire

GUI for Find and Replace operations in Dyalog APL

MIT License

3 stars 0 forks source link

Clicking How to Install link in the doc produces html instead of a rendered page. #8

Closed norberturkiewicz closed 5 years ago

norberturkiewicz commented 5 years ago

Bug or feature?

https://github.com/aplteam/Fire/tree/master/Docs

aplteam commented 5 years ago

Feature.

More precisely: GitHub feature. When you click on an HTML file GitHub shows the code.

When you download a Fire release and then click on that file then it renders fine in your default browser.

norberturkiewicz commented 5 years ago

@aplteam should the ReadMe.md reference howtoinstall.md instead of howtoinstall.html?

aplteam commented 5 years ago

Why? The markdown is the source format, but one wants to looks at the HTML, don't you think?

norberturkiewicz commented 5 years ago

I think it would be more useful if it went to the same file type (consistency) and rendered properly. The ReadMe.html can point to howtointsall.html and readme.md can point to howtoinstall.md. The browser will know what to do with the html and github will nicely show the formatted md.

Not a big deal either way. I just expected a corresponding formatted document when clicking through the repo.