Opened 16 months ago

Last modified 3 weeks ago

#13892 assigned bug

Cortex documentation should be moved into the User Guide

Reported by: waddlesplash Owned by: humdinger
Priority: normal Milestone: Unscheduled
Component: Documentation Version: R1/Development
Keywords: Cc:
Blocked By: Blocking:
Has a Patch: no Platform: All

Description

The old documentation exists in the tree at http://cgit.haiku-os.org/haiku/tree/docs/apps/cortex -- it should be cleaned up and moved into the User Guide.

Change History (8)

comment:1 Changed 4 weeks ago by Tanyi_Tk

I'd like to work on this if no one is working on it.

comment:2 Changed 4 weeks ago by Tanyi_Tk

And if I understand clearly, the entire cortex folder is to be moved to userguide and cleared from its current location?

comment:3 Changed 4 weeks ago by humdinger

Before working on this:

IMO Cortex in its current state isn't needed by the general end user. It is useful for developers of Haiku and 3rd party apps that deal with the media kit. But I doubt the people targetted by the user guide have much use for it.

Wouldn't it make much more sense to outsource Cortex (to HaikuArchive) and have a package for it in HaikuDepot?

If people don't agree, the Cortex page for the user guide cannot be a simple copy & paste of the existing doc. It'd need a description of all the available add-ons, their usage with screenshots, examples etc. Of course, even if Cortex were to be outsourced, such improved docs would be very welcome...

comment:4 Changed 4 weeks ago by pulkomandy

+1 to outsourcing.

+1 to improved docs :)

comment:5 Changed 4 weeks ago by diver

+1 to outsourcing too.

comment:6 Changed 4 weeks ago by waddlesplash

-1 to outsourcing. There are a few Media Kit bugs related to routing that make it less useful, but once we get multiple audio jack support, it will be *very* useful in doing connection routing and parameter tweaking on individual nodes.

comment:7 Changed 3 weeks ago by pulkomandy

It will not be any less useful as a 3rd party app. And I don't expect the regular user to have to tweak parameters manually. Routing connections, maybe... but that's already quite advanced use.

comment:8 Changed 3 weeks ago by KapiX

+1 to outsourcing. I'd rather see us go in the direction of outsourcing more apps, than integrating them. Obviously that can't be done for every app we have but Cortex is a good candidate, since it's pretty big and not an essential part of the system.

Note: See TracTickets for help on using tickets.