Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Anyone happen to know what happened to the Doctrine docs for 1.x? Going through their official documentation page (have to scrolldown to 1.2), and clicking any of the documentation links results in a 404. I have also noticed that several google searches for 1.x docs are doing the same.
Did Doctrine recently change doc structure and forget to update? Or is this their way of telling us to upgrade to 2.x?
-- Update (3.9.2012) --
It appears that Doctrine was in the middle of moving their documentation to GitHub. Some of the links mentioned in OP are now resolving to https://github.com/doctrine/doctrine1-documentation.
-- Update (3.20.2012) --
Looks like some of the documentation has been ported over to their ReadTheDocs portal. Much cleaner interface than browsing the raw .txt files.
According to this thread on github, the powers that be are aware of the problem and should be fixing it soon. Someone posted a link to a cached version of the docs, which works well in the interim.
The current situation is that I'm porting the docs over to reStructuredText on a fork of the official doctrine1-documentation. This is the version you can see over at ReadTheDocs.
The idea is to eventually end up with a reST version of the entire manual, at which point the documentation can be PR'd back into the official repo, built by the same system that builds Doctrine2's documentation, and end up back on the official Doctrine site.
In the meantime, some chapters are nice and easy to read, like Defining Models, while others have yet to receive fixed markup. Help with fixing it all up is welcome (fork).
Doctrine 1.2.4 Documentation
http://doctrinedocs.com
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Background
There is a hardware project going on. A hardware accelerator has been being developed by a team of students but there is no general documentation.
There are READMEs here and there, some docxs and in-code (Verilog, C and Lua) comments, but nothing else. The code is written with Vim, versioned with Git and Markdown is our friend, even if we are not on Github (yet).
Since this “thing” is growing, I feel the necessity of writing down something (user manual? developer notes?) but I don't know where to start.
Question
When someone feels the urge of documenting his project, where does it start?
More specifically, what are the generally accepted criteria to do it and what are the best tools?
My hypothetical answer
We quite clearly need both a developer and user manual. One with details of the algorithmic solutions, the other... like for monkeys.
About the tools, I believe that something like a Github Wiki would work fine, but (1) we are not on Github and (2) wouldn't be LaTeX a better way of writing stuff in order to publicise it, eventually. I know we can get our Markdown rendered in a printable way with http://www.cocowrite.com/, but is it the most efficient solution? LaTeX would be a nuisance for collaborative editing and online HTML publishing.
A partial answer can be found here: “What tools are used to write documentation?”.
Second part of the answer can be found here: “What amount of documentation is needed for a non-trivial one-man software project”
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I know Norman is working on the Netty 4 book as I've been following the tweets, but was wondering if there are any pieces available to help someone who hasn't worked with Netty 3. I have looked a little at the existing 3.x articles, but I think it would be easier to understand the primary components without having to learn 3.x and then mentally apply the New and Noteworthy section to bridge the gap.
For now, I'm just trying to go through the example/test code to see how it's used, but any overview/fundemental documentation would be great. If not, that's ok - just thought I'd check.
Thanks
There is nothing out there at the moment except what you find on the Blog and the javadocs. I'm currently working hard on getting the javadocs up-to-date before our next release, so you may find all you need in there. An other source of informations is like you said the example module which contains a lot examples for all kind of use-cases.
Hopefully the MEAP of the Netty book will start in not so far future. But we will see..
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I learned how to find out which version of ClojureScript I'm using with lein-cljsbuild. Where can I find API documentation for cljs.core?
I had to find out about js-obj from a blog post.
I can look at the source code, but it's a large file and it's mostly clojure.core stuff.
Not exactly thorough documentation, but this cheat sheet is really quite helpful when starting out (and better than nothing!):
http://appletree.or.kr/quick_reference_cards/Others/ClojureScript%20Cheat%20Sheet.pdf
ClojureScript definitely has a documentation problem. You're actually not too bad off looking at the source; it's verbose but not too bad once you get used to it.
That said, one of the reasons nobody has produced a definitive ClojureScript API reference is that the core functions all mirror Clojure, so it would be quite a lot of redundant effort. If a function exists in both languages and doesn't work the same way, it's highly unusual and quite possibly a bug.
In practice, I find that using the Clojure API docs (or something like clojuredocs.org) coupled with very occasional forays into the source code work pretty well for 99% of my cljs work.
ClojureScript API Documentation is being worked on here:
http://cljs.github.io/api
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 8 years ago.
Improve this question
I just installed graphite/statsd for production use. I'm really happy with it, but one of my co-workers asked me if there was a way to make it look prettier. Honestly, I can't say that I haven't wonder the same.
Are there alternatives to the Graphite UI that do a better job rendering data, perhaps using one of the awesome frontend graphing libraries and http push?
Try Grafana
It has a very nice UI and advanced dashboard and graph editing features. Very simple to install.
On the latest Graphite docs page, there is a list of tools which work with Graphite. For reference, here are the ones which seem to be prettification-based:
Charcoal
Descartes
GDash
Giraffe
Graphitus
Graph-Explorer
Graphene
Graphiti
Graphsky
Pencil
Tasseo
Additional interesting resources:
Graphitoid: (an Android-App dashboard)
Graphitejs: (a jQuery plugin for making/displaying Graphite graphs)
Seyren: (an alerting dashboard for Graphite)
For details on each one, check out their pages, or take a look at the description on the first link I added, for the Graphite docs page.
If you don't want to code up your own frontend, you can use Graphiti. It is simple to use and looks great!
A-ha! I did some googling and found Cubism.js which does exactly what I need.
It has integrated support for graphite and provides the necessary graphing components (as a plugin to D3) to create beautiful real-time dashboards.
I can see this is a bit old, but thought I'd add to it for future prosperity:
I went through a few of the options listed in #troy's response (and a few others). You can see my impressions in my blog post
You can try Graphene which is a layer above Graphite:
http://jondot.github.com/graphene/
Anyone tried Orion? Seems to be a good option but overlooked so far.
https://github.com/gree/Orion
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
What tools exist for developing platform indepedent API Documentation?
I'm in the process of designing a proposed API, and want to write documentation in a structured and easily editable way. A lot of the answers I've seen have basically been "Use built in language specific documentation tools", but since I'm designing the API from a 'top-level', rather than implementing it, this isn't so useful. I'm looking for a CMS for API Documentation
I've seen a few suggestions to use PBWiki or Confluence, but I'm not convinced that a plain wiki is the best option, though the version control aspects are nice.
In theory, a Drupal build with CCK for API calls and Views for reading the API, but that's a bit of heavy lifting for what I'm looking for.
Is there a API Documentation Management System out there? What are the best options for writing and managing platform-independent documentation for APIs?
I've seen the related questions for this, but there has yet to be a satisfactory answer.
Any structured text language will do. I'd use latex, and troff is old school.
But you may have missed the point of the suggestion to use doxygen or whatever. If you do that, then writing the documentation is also laying down the scaffold for the eventual implementation. Better still, the example documentation will be in the same format as the eventual real documentation and, you will--of course---use source control on it, won't you? So you'll have a potted history of changes to the spec.