freecodecamp / devdocs Goto Github PK

Using Web Workers is likely to speed up the search (no more setTimeout) and make the UI more responsive (workers run in a separate OS thread), but they have the downside of not being able to share objects with the main page. This would require us to duplicate the index/data in memory and may make the app slower to boot.

I found out about this project from the Postgres Weekly newsletter. The devdocs for postgres (http://devdocs.io/postgresql/) will be very useful to me. One thing that's lacking from the official postgres documentation, though, is the ability to choose a specific version of Postgres. In my case, I'd like to read the documentation for Postgres 9.2 since I'm not running 9.3 yet.

The help page lists a few Cmd key combinations, in particular Cmd + ← and Cmd + → for navigating back and forth in history. On Windows these combinations become Ctrl + ← respectively Ctrl + →, which is highly problematic because that exact behaviour is already mapped to Alt + ← respectively Alt + →. Meanwhile, the Ctrl combinations have a different behaviour: to jump the cursor a full word left or right.

I haven't tested how GNU/Linux compares.

I suggest that, for Windows, the back/forth navigation shortcuts, being first-class citizens, be completely dropped. Failing that, that they be rebound to Alt to avoid the above confusion.

Ctrl + Enter (Cmd + Enter) does not currently interfere with anything so doesn't need special handling.

As an aside, and as a much more innocent issue, I would expect the behaviour mapped to Alt + ↓, Alt + ↑ for ↓, ↑ and ↓, ↑ for Ctrl + ↓, Ctrl + ↑, the rationale being that the default behaviour of ↓, ↑ is incremental scrolling and I would expect to normally have far more need of that than navigating up/down the list of items.

When opening a search result there is currently no way to quickly browse through related entries (with the same type). We could improve this by adding a breadcrumb bar to the UI.

It would be nice if devdocs versions or releases were tagged.

Some documentations have very long pages that are difficult to browse through. We could improve this by adding a fixed-positioned table of contents which is automatically generated based on the current page's headings (<h2>, <h3>, etc.).

I've been playing around with DevDocs and noticed that there are iframes and images loaded from external resources.

Could you please think about making parsers to also download those?

While converting DevDocs books to DevHelp format I've made my own bycicle with square wheels, but its pretty hacky and doesn't rely on your code base (see master at https://github.com/naquad/devdocs - especially lib/downloader.rb and lib/devhelp.rb).

Can you allow scrolling the right hand side, where the documentation is shown, with the up/down arrow keys, if focus is on the right hand side?

Right now, no matter where focus is in the app, the up/down arrow keys change the selected item in the sidebar.

Not all users have multi-touch trackpads, and if they don't they are forced to use the browser rendered scrollbar to scroll the right hand panel up/down.

I would be willing to implement this, but it would help to have a push in the right direction.

Hard to explain, but I tried searching "409 Conflict" which resolves to "409+Conflict" and doesn't return any results... If I search "409" the expected result appears.. also if I put "409%20conflict".. Seems to be an encoding issue.

It's not apparently obvious that I have to activate a documentation set
I saw underscore in my list of potential sources, but didn't activate it. When I was searching, I got no result -- made me think devdocs was broken

I think it might be nice to have a spot where you "Search over non-activated documentation sources" when there are no results

I think that problem in parsing php docs. If you open any documentation page with class definition (for example, http://devdocs.io/php/class.curlfile), you could find missing space in class synopsis:

public stringgetFilename ( void )

instead of

public string getFilename( void )

I want devdocs to run every time my Mac boots.

How should I go about it? I tried using rvm, but ran into this error message when I put the rvm-specific rackup command in the launchctl configuration:

env: ruby_executable_hooks: No such file or directory

Then I tried using "rvm use system" and installing/running rackup and got this error message:

/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/rubygems/dependency.rb:296:in `to_specs': Could not find 'rack' (>= 0) among 4 total gem(s) (Gem::LoadError)
    from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/rubygems/dependency.rb:307:in `to_spec'
    from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/rubygems/core_ext/kernel_gem.rb:47:in `gem'
    from /usr/local/Cellar/ruby/2.0.0-p353/bin/rackup:22:in `<main>'
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/rubygems/dependency.rb:296:in `to_specs': Could not find 'rack' (>= 0) among 4 total gem(s) (Gem::LoadError)
    from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/rubygems/dependency.rb:307:in `to_spec'
    from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/rubygems/core_ext/kernel_gem.rb:47:in `gem'
    from /usr/local/Cellar/ruby/2.0.0-p353/bin/rackup:22:in `<main>'

Then, I tried running

bundle install --path $(shell pwd)

and got an actual segfault, which seems pretty amazing.

/Users/kevin/code/local-servers/usr/devdocs/devdocs-master/ruby/2.0.0/gems/eventmachine-1.0.3/lib/rubyeventmachine.bundle: [BUG] Segmentation fault
ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-darwin13.0.1]

A nice feature would be support for browser keyword search by adding an explicit search URL such as:

http://devdocs.io/search?q=

Using this URL it's possible to add a bookmark to http://devdocs.io/search?q=%s with a shortcut such as "d". Once done, DevDocs searches are possible in the browser address bar, for example:

• d puts: doc for the puts command
• d r puts: doc for the Ruby puts command

first thing I wrote was "checked" and only got a CSS spec. it didn't find any specs for any HTML attributes...

WRT to RFC#2324‎ http://devdocs.io/http-status-codes/ needs 418 ;) ?

I agree that ES6 is evolving as of now, but few of them can have docs?

Following pages are missing from PHP's Strings module

• htmlspecialchars_​decode
• number_format
• strip_tags
• substr_​compare
• substr_​count
• substr_​replace

Typing a tag followed by hitting the tab key in the search field such as "ruby" or "r" does not always work. It's most notably broken on the initial page http://devdocs.io whereas on some subpages such as http://devdocs.io/ruby/array this feature works normally.

Tested on Firefox 26 (Mac and Win), Chrome 32 (Mac) and Safari 7 (Mac).

On angularjs page : http://devdocs.io/angular/
Clicking "ng.filter:json" opens a new page but is empty

DevDocs's offline setup isn't very good, requiring people to manually install, run, and update the code. Ideally we should cache everything in the browser using a storage API.

IndexedDB is supported by most browsers but I'm not sure it can reliably store tens of thousands of files amounting to hundreds of megabytes.

Chrome also supports the FileSystem API.

RT..

should be match the same url with the missing '/'

It'd be great if the app included an <iframe>-optimized version which made it easy to embed DevDocs in other websites.

Hi, first let me say that this project is amazing in a lot of ways.

Second thing, i have a small usability feature request, i will describe the use case shortly.

After inserting some text in the search box (for example, "find") and clicking on an interesting entry (for example, jQuery "find"), the entry's section is selected, and the search box reduces its scope just to that section (in the example case, it will search just within jQuery). I don't find easy, keyboard means to go back to a global search, aside hitting the browser back button, clicking on the bookmark again or editing the url by hand.

Since it happens often to me to jump from one section to another, i would maybe prefer that the section switch did not happen at all, but while this is arguable, i think that an easier way to get back to the global search mode may be of benefit of all kind of users.

Cheers!

I know about https://github.com/Thibaut/devdocs/blob/master/lib/docs/scrapers/angular.rb#L3-L11 but now angular 1.2.0 was released, can't you just grab the data from angular repo directly?

This should be rather easy to port (I believe)

All in subject. For example open http://devdocs.io/php/class.curlfile and try to follow any link in class synopsis. The php.net site opens, instead of devdocs.io.

On the angular.module page, there are are links to angular.Module sections, but they link to angular.module. angular.Module (type in ng) seems to have been missed by the scraper.

Lots of, if not all, Java projects provide Javadocs. It would be great to be able to integrate these.

For instance, the JavaEE 7 official Javadoc license does not permit redistribution to third-parties, so it would be great to be able to integrate them by hand and to browse them in offline mode on a personal basis: there would be no license violation.

Moreover, lots of Java projects which are true Free Software could then be integrated to the full devdocs distribution.

Like the way the jQuery Mobile docs have quick access to CDN at the bottom of the docs, in any doc section for a library or framework, put quick access CDN links on the main page.

Related issue: #18

Found illegal markup added on this Ruby doc :

On http://devdocs.io/ruby/csv#class-CSV-label-Writing, some ";;" are added. These chars should not added.

Example :

CSV.open("path/to/file.csv", "wb") do |csv|
  csv <;;<;; ["row", "of", "CSV", "data"]
  csv <;;<;; ["another", "row"]
  # ...
end

Expected :

CSV.open("path/to/file.csv", "wb") do |csv|
  csv << ["row", "of", "CSV", "data"]
  csv << ["another", "row"]
  # ...
end

Pages like HTML/HTML5 should be included in the search index.

https://developer.mozilla.org/en-US/docs/Web/API/Location.replace

That causes history issue (there's none) in WebKit2 :( Could you please don't use it for navigation? Maybe some HTML5 History API or just location.fragment?

Thanks.

Every link in the PHP docs is treated as an external link, regardless of whether the article linked to exists within the DevDocs library or not. This may be due to the fact that PHP's site is geographically distributed with help from subdomains, so a link to www.php.net/something might redirect to us2.php.net/something - presumably to assist with load balancing. If the subdomain changes between the request and the links, the scraper or processor may not properly detect that the links actually go to the same content, despite having a different domain, and treat them as external.

This isn't a major inconvenience as I can either click the link and continue on the upstream site, or I can remember that the PHP links aren't properly handled and find the article I want via search. Still, it's less convenient and breaks the usage flow, so it would be nice if it was fixed. Had I the time, I'd probably attempt to write the patch myself.

I personally don't mind reading documentation in English but I know quite a few fellow workers who would prefer it in French (or their mother tongue).
I understand that documentation is not always available in all languages but quite a few exist and I think it would be nice to offer the option when it exists.
And I am ready to help if required ^^

I think add multilingual support is a good idea because not everybody speak english very well ;-)

I'd like to be able to rearrange documentations in the sidebar by dragging them in the "Select documentation" list. The order should also be reflected in the search (when results have identical scores).

With user-agent "Mobile" site is loading correctly

Git is a multipurpose tool , thus making it part of Javascript section does not seem relevant.

Apart form Git, are there numerous other docs that are cross-language / technology / platform ? It may be wise to create a "Tools" section.

I am trying to install devdocs on a Ubuntu 12.04 LTS platform but when running the 'bundle install' command I get the error "Could not find html-pipeline-1.2.0 in any of the sources". It appears that this particular version is referenced in the Gemfile.lock but has been "yanked" from the site :-(
Which version should I use?

I was thinking of scripting up a desktop wrapper for devdocs. Currently I have it wrapped with Fluid as indicated in your docs, but it would be nice to improve the wrapper with taskbar/menu options, a custom app icon, and have proper sync abilities so it can load offline if need be. I was thinking TideSDK, Node-Webkit, or even trying out the new Brackets-Shell.

Thoughts?

It would be great to be able to create profiles, ie "frontend", "backend" each having different settings (available languages/tools).

This implies supporting login, using GH login could be great.

Lastly I want to thank you for this app, really great !

Opening a new issue per documentation.

It would be really useful to be able to add a repo to devdocs and have it import that repos Readme or have some sort of similar plugin architecture.

I am using Firefox 26 and my keyboard shortcuts don't work now. They used to, when I first visited DevDocs,f but don't now. Probably since the last update?

The PageUp/PageDn keys work normally, so do the Alt+Arrows. But,

Arrow keys don't select the next/prev function as they used to. "Search as you type" also doesn't work.

This isn't an intentional change, is it?

Once DevDocs supports a few more documentations it may be a good idea to organize the "Select documentation" list by "kind" or programming language.

It seems to not be possible to select text with the mouse in the search box.

When looking at documentation from different sources it's difficult to tell at a glance which source you're looking at. For example, when looking up event.preventDefault you'll get a result for DOM and jQuery. When reading the documentation, there is no visual difference between the two since they're styled the same, except for the icons in the results sidebar.

I recommend adding some sort of color difference for different sources, within the documentation pages. For instance, a blue header with the jQuery logo for jQuery vs. a green header with the DOM logo for MDN DOM documentation. It'll make it very easy to tell at a glance which source you're reading from.

When I click any of the links from Angular JS and down, I see that the URL in the browser is switched so that the section is added on the end.

For example, if I click "python", and try to search for itertools, I see the URL change from devdocs.io to devdocs.io/python, but no python stuff when I search:

... only HTMl / JS / web stuff.

Only if I manually select the URL bar in the browser tool bar and hit [Enter], the search works properly.

System info:
OS: Xubuntu 13.10 64bit
Browser: Chromium, Version 31.0.1650.63 Ubuntu 13.04 (31.0.1650.63-0ubuntu0.13.04.1~20131204.1)

Those does not exists:
http://devdocs.io/css/nav-down
http://devdocs.io/css/nav-index
http://devdocs.io/css/nav-left
http://devdocs.io/css/nav-right
http://devdocs.io/css/nav-up

Linked from http://devdocs.io/css/