adam-singer / dart-carte-du-jour

Pub documentation generation system
www.dartdocs.org
Other
25 stars 8 forks source link

url optimization #56

Closed adam-singer closed 10 years ago

adam-singer commented 10 years ago

From @devoncarew you may want to optimize for the latest link. So instead of http://www.dartdocs.org/foo/latest/index.html, something like:

http://www.dartdocs.org/foo/

which itself could redirect to http://www.dartdocs.org/foo/index.html. The specific version urls would be less frequently used and can be longer and a bit more explicit:

http://www.dartdocs.org/foo/versions/0.6.1/index.html


Response from @financeCoding

Not sure how stable it would be with having a "versions" path within an existing documentation package.

Maybe something like

http://www.dartdocs.org/foo/latest/index.html http://www.dartdocs.org/foo/versions//index.html http://www.dartdocs.org/foo/index.html <- having this redirect http://www.dartdocs.org/foo/latest/index.html, assuming using meta refresh is a unfriendly way to redirect?


devoncarew commented 10 years ago

Not sure how stable it would be with having a "versions" path within an existing documentation package.

Yeah, not 100% safe, but I think reasonably safe. Keeping the urls short and semantic is nice. You could shorten the versioned urls a bit to maybe lessen the chance of a url conflict. So:

http://www.dartdocs.org/foo/ http://www.dartdocs.org/foo/0.6.0/

which would depend on there not being a directory named 0.6.0 in the foo package. In any case, my 0.02 :)

sethladd commented 10 years ago

I'd rather make the homepage for a package be pub.dartlang.org/foo and then let that decide which URL for the docs we link to.

Reason: cloud storage is very hard to say "delete a directory of stuff and replace it with these contents". I want to keep dartdocs.org as simple as possible, so just "build docs and put em in cloud storage" is ideal.

I'd like to avoid building in any nav systems or logic into dartdocs.org, if possible. pub.dartlang.org already has a nav system and logic for "latest".

adam-singer commented 10 years ago

sgtm