Talk:SDK Docs

From Valve Developer Community
Revision as of 07:58, 29 June 2005 by Tom Edwards (talk | contribs)
Jump to: navigation, search

The idea of having a 'community area' for the documentation index seems redundant. Over time, I wouldn't want the site to split into the areas that Valve authored vs. the areas that the community authored. Does it make sense to roll this into the rest of the index? Erik Johnson

I agree. I think it will complicate the process of finding the information you want, mix up the Wiki categorization, and make us wonder if it's okay to edit the original documents. And there are already a few documents written that have already been mixed in.

- Mungo

I played it safe and assumed you wouldn't want the two mixed. I'll merge them now. --Tom Edwards 11:10, 28 Jun 2005 (PDT)

OK, problem. We are currently linking to Categories with {{Category:Modeling}}. That displays the description of the category and they've all been filled in to have all the current pages. But that isn't the category, it's just a copy of it. If anyone wants to add to the description they've got to go and manually edit the page, defeating the point of having a category in the first place. We need to be able to list the category contents themselves on the page if we want it to keep itself up to date, or link through to the category pages and lose searchability. --Tom Edwards 11:25, 28 Jun 2005 (PDT)

Doing it this way allows the topics to be manually arranged in a useful order on this page by editing the Category pages. But, yeah, there should probably also be a link to each category page here so you can also jump to the alphabetical lists. edit: I see you added that...I think it's a good solution. It is still an extra step to manually edit the category pages, but that lets us put them in a useful order for this page. -Mungo

TBH I think alphabetically is the most useful. The current setup doesn't solve the problem of getting the self-updating lists onto the main page though, so it's not terribly useful. --Tom Edwards 11:49, 28 Jun 2005 (PDT)

True, alphabetical is very useful. I thought it could be useful to arrange these in tables with headings like Basics, Advanced, Troubleshooting. Then if someone wants an alphabetical list, they can click on the title. I don't know if the software can automatically put the alphabeticized lists on this page. -Mungo

That's a good idea, but a lot of work. It will get forgotten and be worse than useless because everyone will assume what's there on the page is all there is. --Tom Edwards 12:14, 28 Jun 2005 (PDT)'s already too much work to manually add new topics to their category pages so they appear here. But I don't know if there's a solution to that. Maybe it would be best just to put a small note after the big categories like Level Design and Coding that links to the Category page. Otherwise, this page is going to become an enormous, unorganized, incomplete list. -Mungo

Or go back to descriptive categories with titles as links. ;-) --Tom Edwards 12:23, 28 Jun 2005 (PDT)

Okay, I like this: Do what you said, but type the descriptions directly into this page. Then on the category page, we have the option to put an organized short list(s) of some of the basic articles that beginners would want to look at first. The alphabetical list automatically appears below. --Mungo

Isn't AI just part of Level Design? -Mungo

Aren't materials too? It's signifigantly different and in future will likley contain coding material too. --Tom Edwards 07:58, 29 Jun 2005 (PDT)