There is also a voting system in place to request new documentation sets, although anyone can contribute, as explained by Thibaut:Īnyone is welcome to contribute new documentations.
#Graphql devdocs update
If I miss a release, DevDocs's users are welcome to request an update on our Trello board".ĭevDocs has been open sourced and welcomes contributors. Thibaut asserts "the existing documentations are updated often, usually within a few days of a new version being released. Since all the documentation published on DevDocs is scrapped, the update process is not instantaneous. The DevDoc's HTML home page is an illustrative example of what DevDocs looks like: Thibaut Courouble, DevDocs' creator, told InfoQ that additional documentation sets are on the pipeline: "I recently started working on the Linux man pages, with Bash, C, C++, D3.js and Knockout.js also on my short-term todo list".
The app's main goals are to: keep booting and loading times as short as possible improve the quality, speed, and order of search results maximize the use of caching and other performance optimizations maintain a clean, readable user interface support full keyboard navigation reduce "context switch" by using a consistent typography and design across all documentation sets reduce clutter by focusing on a specific category of content (API/reference) and by indexing only the minimum useful to most developers.ĭevDocs currently offers documentation mainly targeted for web development including: standards (e.g.: HTML, HTTP, CSS) languages (e.g.: Ruby, Python, JavaScript) libraries (e.g.: jQuery, Ember) and products (e.g.: Ruby on Rails, PostgreSQL, Redis, Git). DevDocs takes advantage of this centralization to offer crosscutting features to all the APIs such as a searchable interface, keyboard shortcuts, common layouts or a common table of contents.Īccording to DevDoc's vision statement: DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable. DevDocs combines multiple reference documentation sets, commonly used by software developers, in a single web site.
0 kommentar(er)
