Add more categories #25

Activity

1. ChristianGreiner

   changed the title [-]Categorize some topics[/-] [+]Add more categories[/+] on May 24, 2018
2. ilexp

   added

   ImprovementExtended or improved info on topicExtended or improved info on topic

   DiscussionNothing to be done until decided otherwiseNothing to be done until decided otherwise

   InfrastructureArea: Project infrastructure, meta-issues, refactoring and bigger high level changesArea: Project infrastructure, meta-issues, refactoring and bigger high level changes

   on May 26, 2018
3. ilexp commented on May 26, 2018

   

   ilexp

   on May 26, 2018

   Member

   More actions

   I think having better categories is a great idea, but we should also utilize nested pages as well to keep the number of top-level pages down, see this comment.

   I think it would be more helpful if we change or add some more categories like:

   Duality Editor (all editor features, extending the editor)
   Graphics (e.g. Shaders, Animations)
   Physics (Rigid Bodies, Forces)
   Coding (Components, plugins)
   Audio (3D Sound, Music, Sound Effects)
   Platform (Deployment on Windows (and Linux / Mac)

   Looks reasonable to me, would maybe adjust one or to items slightly. Maybe it would make sense to pull apart "Basic Topics" and "Advances Topics" and re-sort their items into the new categories. How about something like:

   • Introduction: Home, Should You Use, Community, Meta
   • Tutorials: Getting Started and other step-by-step tutorials
   • Basics: GameObjects, Components, etc.
   • Graphics: Shaders, Animations
   • Audio : 3D Sound, Music, Sound Effects
   • Physics: RigidBodies, shapes, forces, etc.
   • Editor: Editor features, extending the editor
   • Platform: Deployment on various platforms, lowlevel platform interfaces, backend dev and info
   • Contributing: How to contribute, Duality dev, maintenance topics
4. ilexp commented on Feb 10, 2019

   

   ilexp

   on Feb 10, 2019

   Member

   More actions

   Added some features to our Jekyll setup to make it easier to do bigger category changes across docs versions.

   Progress

   • Introduced a versioned "Home" page to allow access to top-level pages that no longer exist in the latest version and ease navigation within old docs.
   • Top-level pages to be displayed in Home sidebar are now determined automatically based on their parent and category variables.
   • Replaced top-level category definition with a generic array of category descriptions that does not imply their display in the sidebar. Only categories that are used in the current versions docs will be displayed. Different docs versions can use different categories.
   • Child / sibling page display in the sidebar is now sorted by displayOrder.
   • Pages can now specify formerPaths in order to allow access to all versions of a page even when the page was renamed or moved to a different folder / URL.
   • Added explicit defaults for all used / custom Jekyll Front Matter variables in _config.yml, also serving as a small documentation on how to use each of them.

   ToDo

   • Define new top-level categories and page hierarchy.
   • Apply the new structure, but only to the v3 version of the docs. Keep the old docs as they are.