This site has been retired. For up to date information, see handbook.gnome.org or gitlab.gnome.org.


[Home] [TitleIndex] [WordIndex

Developer Documentation

Designs for developer documentation website and app.

Participants

AllanDay

Objectives

Content to include

API Reference

General

Additional website specific goals

Additional Builder specific goals

Relevant Art

Websites

Dash

http://christophheer.me/static/img/2012-07-30-dash/search_datetime.png

Devhelp

devhelp.png

Discussion

Open questions

Tentative Design: Desktop Site

This design is based on the existing organization and capabilities for API reference documentation. It would be good to think about additional features/organization, to enable browsing the symbols in a meaningful way.

gnome-developer.png

Tentative Design: Mobile Site

https://raw.githubusercontent.com/gnome-design-team/gnome-mockups/master/gnome-developer/gnome-developer-mobile.png

Comments

Philip C, June 24

My main comment is about the search results. I think the search functionality you've shown at the bottom is OK for the prose sections, but search is my main way to access API documentation and I think it should work more like DevHelp's or DevDocs' search. (This is one reason why I never use the API documentation that's currently on developer.gnome.org; the search is too cumbersome because it opens in a new tab, and I can't browse search results next to the documentation page that I currently have open.)

And if we do change the API documentation search, maybe the prose search should act more similarly to it? Or maybe not.

Various minor comments:

AllanDay, June 28

I've updated the mockups today, these:

About version and language controls, I'd have them scroll along with the page (since they won't be used so frequently so as to need to always be available).

For the How Do I guides, the main thing is to have a bit more integration with the website - it's important to have an overview page with a description of each guide, for example. It would also be good to have some editorial control, to ensure that the guides are well-written and have consistent titles etc. Converting to Markdown might be good for this, but it's something that will need to be discussed with Alison and the authors of the guides.

See Also


2024-10-23 11:04