Wed, 20 Mar 2013 12:09:54 +0100 -n jeremy rosen <[email protected]> írta:
> I would add a section about handling bugs/patches I think that could go in the 'workflow' section. > and some sections > would probably be better after the git migration has settled down and > we have a better idea of our policies wrt git branches, merges etc... Sure, there's no danger that I'll write the whole thing overnight. > how do you plan to write it ? as a set of wiki pages ? > Yes. > > On Wed, Mar 20, 2013 at 12:04 PM, Lipka Boldizsár <[email protected]> > wrote: > > > Hi all, > > > > I'm planning to start a new documentation project for Wesnoth. In my > > view, we could greatly benefit from a manual that gives an overview > > of each larger module of the game, describing the key concepts and > > structures of that area. This could help newcomers a lot, but more > > experienced team members could is it as well, I believe. > > > > The manual doesn't aim to be reference. It wouldn't document every > > single function and member. Instead, I'd like it to include a list > > of key classes and methods of the module, what they're supposed to > > represent and how do they interact. This way, the manual needs to be > > updated only after major refactorings, adding almost no overhead to > > the everyday workflow. > > > > I'm interested in your opinion and the topics you could help > > writing; here's a list of sections that I might be capable of > > writing: 1) Development workflow: the software and communication > > channels we use, policies regarding commits, backports, etc. > > Probably should be made by someone else, I'm infamous for failing > > to comply with those standards... 2) Wesnoth coding basics: the > > most common utilities we use (config et al), coding standards (the > > relevant wiki sections could be reused) 3) MP game setup: an > > overview of the setup screen, how the different components are > > assembled into the level config. > > > > Some others I have in mind: > > 1) An overview of the RCA AI > > 2) The editor > > 3) Writing GUI2 dialogs > > 4) Animation engine > > > > Opinions welcome! > > > > Regards, > > lipk > > > > > > _______________________________________________ > > Wesnoth-dev mailing list > > [email protected] > > https://mail.gna.org/listinfo/wesnoth-dev > > _______________________________________________ Wesnoth-dev mailing list [email protected] https://mail.gna.org/listinfo/wesnoth-dev
