Talk:Development/Documentation: Difference between revisions

From KDE TechBase
(Agree to documentation layout.)
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
I think that a number of the articles this page is linking to should rather be under Development/Tutorials and the scope of this page should be reduced. A page called Devlopment/Documentation seems like it could cover ''everything'' --[[User:Milliams|milliams]] 16:18, 19 February 2007 (CET)
todo: integrate (+ validate for kde4) those pages into sane locations ;)
 
----
 
Ok, let's go through the list:
* Makefile.am Howto
: should go to [[Development/Tutorials/KDE3]]
* Finding out about KDE's installation - kde-config
: already exists [[Development/Tools/Using_kde-config|here]]
* KConfig Module HOWTO
: should go to [[Development/Tutorials/KDE3]]
* Debugging HOWTO
: already exists [[Development/Tutorials/Debugging|here]]
* Driving Konqueror from the command prompt
: already exists [[Development/Tools/Using_kfmclient|here]]
* Memory leak hunting HOWTO
: should be cleaned up and integrated [[Development/Tutorials/Debugging|here]]. maybe I even did that already
* KDE Internationalization (i18n) HOWTO
: already exists [[Development/Tutorials#Localization|here for kde4]], and if at all should be in [[Development/Tutorials/KDE3]] for kde3
* Porting to Qt 4 and KDE 4 Porting Guide
: partly exists already [[Development/Tutorials/Porting|here]], see also the [[Talk:Development/Tutorials/Porting|discussion]]!
* KDE API Reference Documentation HOWTO
: already exists [[Development/Tutorials/API_Documentation|here]]
* KDE 3 Porting Guide
: do not port at all (kde2 is deprecated! really), or put it into [[Development/Tutorials/KDE3]]
 
and:
* Binary Compatibility Issues with C++
: already exists [[Policies/Binary_Compatibility_Issues_With_C++|here]]
* Common Programming Mistakes
* Common Programming Mistakes
: hey, the first one we have not ported yet. should be moved for kde4 into [[Development/Tutorials]] (TODO)
: hey, the first one we have not ported yet. should be moved for kde4 into [[Development/Tutorials]] (TODO)
:: Thinking more about it, it could be an extension of [[Policies/Library_Code_Policy]], i.e. as subpage like [[Policies/Library_Code_Policy/Common Mistakes]] (although it's not only about libraries...) --[[User:Dhaumann|Dhaumann]]
* KDE Developer's Checklist
* KDE Developer's Checklist
: look svery old. if migrated, please fix it for kde3 or even kde4 (TODO)
: look svery old. if migrated, please fix it for kde3 or even kde4 (TODO)
* Designing Qt-Style C++ APIs
: we don't need it. the link is already mentioned in [[Policies/Library_Code_Policy]]
* Shared Memory Notes
: indeed, we don't have that ported, yet. I think it makes sense to add it to [[Development/Tutorials/Debugging]] as a short article (TODO)
* What is Scripty?
* What is Scripty?
: indeed a TODO :)
: indeed a TODO :)


The rest of the links are already in the Tutorials section (at least the important ones).
--[[User:Dhaumann|Dhaumann]] 14:58, 25 February 2007 (CET)
 
As you can see, I/we have put a *lot* of efforts into this. I don't see a reason right now to have Development/Documentation at all. I'll remove it again, if you guys agree :)
 
::so we have 4 TODOs if we count the developer's checklist (which seems really old indeed, but useful to have?) ... i'm in favour of getting those done as per your notes and agree that this page can go...
 
--[[User:Dhaumann|Dhaumann]] 19:56, 19 February 2007 (CET)
 
Sorry about the duplication then, I just started so I didn't realize that many of the articles had already been migrated, please feel free to rearrange as you like. --[[User:Mpyne|Mpyne]] 00:18, 21 February 2007 (CET)

Latest revision as of 13:59, 25 February 2007

todo: integrate (+ validate for kde4) those pages into sane locations ;)

  • Common Programming Mistakes
hey, the first one we have not ported yet. should be moved for kde4 into Development/Tutorials (TODO)
Thinking more about it, it could be an extension of Policies/Library_Code_Policy, i.e. as subpage like Policies/Library_Code_Policy/Common Mistakes (although it's not only about libraries...) --Dhaumann
  • KDE Developer's Checklist
look svery old. if migrated, please fix it for kde3 or even kde4 (TODO)
  • What is Scripty?
indeed a TODO :)

--Dhaumann 14:58, 25 February 2007 (CET)