Please DRY up home pages #116

Closed
ma11hew28 opened this Issue Jun 26, 2011 · 3 comments

Comments

Projects
None yet
2 participants

I was looking for instructions on how to comment, i.e. this page http://tomaz.github.com/appledoc/comments.html, but after about 30 seconds of searching, I didn't find anything, so I figured such instructions didn't exist.

See, when I read "appledoc's GitHub page" on the Readme.markdown, I figured that was the page I was already on (https://github.com/tomaz/appledoc), so I didn't bother clicking the link. (See 3 below.) So, I didn't know http://tomaz.github.com/appledoc/ existed, and a Google search for appledoc showed http://www.gentlebytes.com/home/appledocapp/ as the first hit, so I figured that was the home page and didn't see any links to comment instructions...

Solution:

  1. 301 Redirect this http://www.gentlebytes.com/home/appledocapp/ to http://tomaz.github.com/appledoc (should get you mroe link juice there too)
  2. Just put a link in the Readme.markdown to http://tomaz.github.com/appledoc
  3. In Readme.markdown, change "appledoc's GitHub page" to "appledoc's homepage."

That should DRY things up...

Owner

tomaz commented Jun 27, 2011

I agree that it might be confusing - even for me, although that's partially due to how GitHub and it's gh-pages feature works. The "home" for appledoc is http://appledoc.gentlebytes.com and there are links to both, source code and online docs Source code is on http://github.com/tomaz/appledoc and online documentation on http://tomaz.github.com/appledoc (the last two are urls GitHub assigns and I find gh-pages one especially confusing). I've made sure there are links to online documentation on both, the readme and home page and am planning to embed online documentation directly to gentlebytes.com (once I manage) and I think that will solve much of this. I was never fond of switching branches to write documentation and with new home page layout I can integrate documentation much more easily.

@tomaz tomaz closed this Jun 27, 2011

Cool. Cool. Yeah, that'll definitely solve this.

Sweet looking documentation BTW! :)

Matt

Sent from my iPhone

On Jun 27, 2011, at 1:29 AM, tomazreply@reply.github.com wrote:

I agree that it might be confusing - even for me, although that's partially due to how GitHub and it's gh-pages feature works. The "home" for appledoc is http://appledoc.gentlebytes.com and there are links to both, source code and online docs Source code is on http://github.com/tomaz/appledoc and online documentation on http://tomaz.github.com/appledoc (the last two are urls GitHub assigns and I find gh-pages one especially confusing). I've made sure there are links to online documentation on both, the readme and home page and am planning to embed online documentation directly to gentlebytes.com (once I manage) and I think that will solve much of this. I was never fond of switching branches to write documentation and with new home page layout I can integrate documentation much more easily.

Reply to this email directly or view it on GitHub:
#116 (comment)

Owner

tomaz commented Jul 7, 2011

Procrastinated this for a long time, but finally moved documentation to home page. While in the process, I also brushed on the docs a bit. It's not yet perfect, but definitely better than before. If nothing else, at least I can edit the docs with same tools as the rest of the homepage...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment