https://bugzilla.wikimedia.org/show_bug.cgi?id=46526
Web browser: ---
Bug ID: 46526
Summary: System documentation integrated in source code
Product: MediaWiki
Version: unspecified
Hardware: All
OS: All
Status: NEW
Severity: enhancement
Priority: Unprioritized
Component: Documentation
Assignee: [email protected]
Reporter: [email protected]
Classification: Unclassified
Mobile Platform: ---
Proposed by Aaron Schulz and extracted from
http://www.mediawiki.org/wiki/Mentorship_programs/Possible_projects#System_documentation_integrated_in_source_code
"It would be really nice if inline comments, README files, and special
documentation files could exist in the source code but be exported into a
formatted, navigable system (maybe wiki pages or maybe something else). It
could be something like doxygen, accept better and orientated to admins and not
developers. Of course it should integrate with mediawiki.org and
http://svn.wikimedia.org/doc. The idea would be that one could:
* Keep documentation close to the code and thus far more up to date
* Even enforce documentation updates to it with new commits sometimes
* Reduce the tedium of making documentation by using minimal markup to specify
tables, lists, hierarchy, and so on, and let a tool deal with generating the
html (or wikitext). This could allow for a more consistent appearance to
documentation.
* When things are removed from the code (along with the docs in the repo), if
mw.org pages are used, they can be tagged with warning box and be placed in
maintenance category."
Submitted here for feedback. If we can have a rough plan and at least one
potential mentor perhaps we could push this project idea to
https://www.mediawiki.org/wiki/Summer_of_Code_2013#Project_ideas
--
You are receiving this mail because:
You are the assignee for the bug.
You are watching all bug changes.
_______________________________________________
Wikibugs-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l
