These are some of my ideas on Shaun's ideas about the future of GNOME documentation :)

Documentation Editing

  • On the web

    • Storage for every GNOME projects' documentation
    • Separated by versions, so we always have access to the old docs, or we can have -stable and -devel docs
    • Have a way for doc writers to create an account, so they can edit documentation live.
    • It would work like a wiki, providing revisions for each "pages" of each documentations
    • Each documentation could be marked as opened, closed, frozen-for-release, etc...
    • When needed, packages of the ready-to-go documentation could be generated
    • A page could show the overall status of all documentation so we know where we're at.
  • On the desktop

    • Have a CLI application that lets people fetch/install whichever docs of any application, any version, etc... or a direct update to the latest documentation available.
    • Potentially an easy-to-use documentation editor that works together with the web-interface.
    • I don't personally think putting editability directly into Yelp would be a good idea, since most users that will use Yelp aren't doc writers (I hope).
  • Basically...

    • Central place for all docs...
    • svn and git aren't really made for documentation
    • Wikis are pretty good at it, and in a way, they're VCSes for text documents.
    • Making it much easier, without the need for 100 different packages just to write docs, more people will contribute, which will lead to better documentation.
    • Easy way to get the documentation for anyone who needs it, for whatever reason.
    • Having it available for editing from the web also lets outsiders that might be more knowledgeable about one of the docs' subjects contribute to it without trouble.

Mega GNOME programming tutorial

  • Yes, yes, yes!
  • Maybe go through all the phases of making a simple application that respects the way GNOME applications are made. From programming it, compiling it, using <current-gnome-VCS> to manage it, making it translatable/localizable, making an actual release, etc...

  • I think one of the GNOME developers wrote a book on GNOME development, which is somewhat similar, but it's a little outdated I think.
  • GnomeDeveloperKit

API Reference

  • A section on lib.go where people can search function names directly, similar to's manual.
    • You type in a function name (i.e., strtok) and it brings you to the page about that function.

  • Links between tutorials and a tutorial about Cairo could point to the Cairo API ref, and vice-versa


LouisHandfield/DocIdeas (last edited 2009-04-15 21:51:41 by LouisHandfield)