GithubHelp home page GithubHelp logo

All docs on one site about docs HOT 14 CLOSED

mitar avatar mitar commented on May 30, 2024 2
All docs on one site

from docs.

Comments (14)

lorensr avatar lorensr commented on May 30, 2024 3

I think the killing mobile browsers might have been the fact that it was a meteor app displaying a large page – I think a static page might be fine

from docs.

lorensr avatar lorensr commented on May 30, 2024 1
  1. The search (#5) will hopefully be as good as find in page.
  2. In what ways is single page better for jumping and navigating?
  3. We might want to recommend http://devdocs.io/ for viewing offline?

from docs.

mitar avatar mitar commented on May 30, 2024

The search (#5) will hopefully be as good as find in page.

Hm, I prefer my own browser search over search engines. :-) And it does not work offline, probably.

In what ways is single page better for jumping and navigating?

Hm, at least it is faster to scroll then click. Also it is easier to skim sections and find one you want than having to guess where stuff is in some hard-coded categorization.

We might want to recommend http://devdocs.io/ for viewing offline?

I think it should be pretty easy to render all markdown documents into one huge HTML file and link to it? Not sure if we need external service for that?

from docs.

tmeasday avatar tmeasday commented on May 30, 2024

The whole thing on one page is bad because it kills mobile browsers amongst other things.

We'd like to figure a way to get the whole thing into a pdf or better yet a single page for printing (from which a pdf could be generated), we've discussed this a fair bit on the guide as well meteor/guide#166.

PRs welcome ;)

from docs.

mitar avatar mitar commented on May 30, 2024

I am saying that it should be an option, not necessary even a default. And yes, it would be useful for printing as well. :-)

from docs.

tmeasday avatar tmeasday commented on May 30, 2024

Well maybe. But there are other benefits to the multi-page too.

from docs.

brucejo75 avatar brucejo75 commented on May 30, 2024

I would like to add to @mitar use case. How many hits do you get from mobile? How many from desktop? By hits I mean any click on the page, not page loads.

I think I hit this page 50-100 times a day on a good development day. It is my homepage for the Chrome browser. I am not sure what the mobile scenario is exactly, but I would bet it is a verification of something while in a meeting or talking with someone else.

The core use case is while writing code, it may be unwise to optimize too much for the mobile case at the expense of the core case.

Thanks for listening!

from docs.

tmeasday avatar tmeasday commented on May 30, 2024

I think it'd be pretty easy to create a hexo plugin that sets up a route that renders all pages in one big document. Not going to have time to look at it in the near future but would happily help someone figure it out!

from docs.

brucejo75 avatar brucejo75 commented on May 30, 2024

Any chance we could post the old docs while this gets worked out?

I tried load the docs locally, but it fails on windows?

from docs.

tmeasday avatar tmeasday commented on May 30, 2024

I wrote up an issue here if someone wants to take a stab at this: meteor/meteor-theme-hexo#12

from docs.

tmeasday avatar tmeasday commented on May 30, 2024

@brucejo75 you can check out meteor/meteor master branch and run the local docs app if you want the old site.

from docs.

brucejo75 avatar brucejo75 commented on May 30, 2024

@tmeasday, thanks Tom! I went into the docs directory and ran meteor. Then brought up the page. It is v1.2.1.

Is the v1.3 stuff still available? A lot of stuff is missing. Like Accounts.userCreate, funny.

Is there something I can do to get it to point to v1.3?

thanks!

from docs.

brucejo75 avatar brucejo75 commented on May 30, 2024

Urp... never mind. I forgot to update to master branch (still pretty new to git, etc). All is great now!

I still think it may be valuable to post this page somewhere.

thanks again.

from docs.

filipenevola avatar filipenevola commented on May 30, 2024

I'm closing this issue because it's too old.

If you think this issue is still relevant please open a new one.

from docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.