x

Search in
Sort by:

Question Status:

Search help

  • Simple searches use one or more words. Separate the words with spaces (cat dog) to search cat,dog or both. Separate the words with plus signs (cat +dog) to search for items that may contain cat but must contain dog.
  • You can further refine your search on the search results page, where you can search by keywords, author, topic. These can be combined with each other. Examples
    • cat dog --matches anything with cat,dog or both
    • cat +dog --searches for cat +dog where dog is a mandatory term
    • cat -dog -- searches for cat excluding any result containing dog
    • [cats] —will restrict your search to results with topic named "cats"
    • [cats] [dogs] —will restrict your search to results with both topics, "cats", and "dogs"

[Request] Documentation structure

I have fairly simple request. Can we get better structure documentation ? What I mean:

  1. Tree Link structure on the side, that is always visible.

  2. Less interdependencies. Just create several categories, then subcateogries and put documentation under them. We really don't need split like Technical Guide, Technical Artist (which in most cases share the same links), or Content Creation and Content Pipline & assets, which are virtually the same thing. Only thing that It brings is utter confustion to where to look for things.

  3. Instead Make 5 categories like: "Beginners, Editor Usage, Content Creation, Technical Documentation, Programming". Content Creation would gather all stuff about well, creating content for engine (not related to edior it self). Editor Usage would gather all things you can make inside editor (very important), Technical Documentation would only focus on theoretical side of things. There can be of course more categories, but please keep them simple, meaningful and unique. Single article should belong to single category in tree structure.

Product Version: Not Selected
Tags:
more ▼

asked Mar 11 '14 at 04:54 AM in Everything Else

avatar image

ue4-archive ♦♦ STAFF
50k 3670 1999 9124

avatar image ue4-archive ♦♦ STAFF Mar 11 '14 at 04:54 AM

I second. Since you're using Bootstrap, follow the Bootstrap wiki model (sidebar especially). IMO, it will also make it much easier to maintain. As an example, the content list in the Coding Standard can be made a sidebar, but more appropriately a lot of the pages in Gameplay Programming can be condensed into one page with headers and a sidebar.

(comments are locked)
10|2000 characters needed characters left
Viewable by all users

1 answer: sort voted first

Hey guys, thanks for the input. We are always looking at ways to improve the layout and presentation of information in the documentation. We will definitely take your ideas into consideration.

more ▼

answered Mar 11 '14 at 04:54 AM

avatar image

ue4-archive ♦♦ STAFF
50k 3670 1999 9124

avatar image ue4-archive ♦♦ STAFF Mar 11 '14 at 04:54 AM

If I had to suggest some layout, then look at it: http://docs.cryengine.com/display/SDKDOC1/Home There is ic nice bar on left, and in generally there is no clutter, as everything is nicely organized in single tree, with few cateogries.

(comments are locked)
10|2000 characters needed characters left
Viewable by all users
Your answer
toggle preview:

Up to 5 attachments (including images) can be used with a maximum of 5.2 MB each and 5.2 MB total.

Follow this question

Once you sign in you will be able to subscribe for any updates here

Answers to this question