search

TransforMap / data.transformap.co

Here you find a Node.js daemon to serve the public TransforMap web service.
https://data.transformap.co
GNU Affero General Public License v3.0
7 stars 2 forks source link

Documentation issues #42

Closed ponder2342 closed 7 years ago

ponder2342 commented 7 years ago

The link to viewdocs.io in README.md should be working now. Also fixed error in install.md - dev-env should be started with npm run watch and not npm watch

almereyda commented 7 years ago

Thanks for finally creating an index.md!

I guess the absolute URL path /viewdocs/... does not exist nowhere. Given the working URI

http://transformap.viewdocs.io/data.transformap.co/install/

It could probably also just read ./install/?

ponder2342 commented 7 years ago

You are right. The link is not working. I am sorry that I did not "thoroughly" test before making a pullrequest.

I've taken the pattern on how to link to other docs inside your docs directory from the original viewdocs documentation. If you have a look at the index.md from the original project you can find the line

This page is an example of what documentation will look like by default. Here is [another example page](/viewdocs/example). The source for these pages are in the [docs directory](https://github.com/progrium/viewdocs/tree/master/docs) of the Viewdocs project.

where a working link in the same style is presented that is linking to the example.md page in the docs directory. Instead of /viewdocs/... it should probably be /$project_name/.... Only now it occurs to me that viewdocs is the name of the project. I somehow though "wow. they are going to have magic that makes all the /viewdocs links point to the correct file".

If committed a change where I did exactly that and now it is working as expected.

almereyda commented 7 years ago

Yes, the URL path for viewdocs is http://<GITHUB_ACCT>.viewdocs.io/<GITHUB_PROJECT>/.... Yet I still think a relative path starting with ./<PAGE>/ would have been more useful than an absolute one starting with /<GITHUB_PROJECT>/<PAGE>/.