You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current documentation is now compiling without any errors but going through the whole documentation you can see that there is a lot of redundant information and probably miss located documentation which should be moved and collected under an other topic.
clear and up to date screenshots - to be done before the 1.2 release
current and correct information relating the use and functionality of InaSAFE - some developer info is still not up to date
all sections having an appropriate anchor so that we can 'hook' into that context from the program code to display localised help for a given context. - waiting for new structure
There is the Idea of having it structured like that:
Landing page: short info about whole stuff like it is in the upcoming landing page
General: General info about the Project
About
News
Press Material (scientific-references)
Changelog
Current Release Information (activities)
Tutorials
Material that should be kept together as one but just branded as InaSAFE Tutorial to be able to just take a tutorial out of that section and work through it with a class or any audience
Tutorials should either have a subdirectory here or might probably consist of only one .rst file (like the tutorial.rst is now)
current socialisation from here should be split up into topics and moved one level up into tutorials
We need to investigate what parts should stick together and what can be taken out as separated tutorial
User MANUAL(User Documentation)
Beside the Tutorials a brief overview about every function you can use in InaSAFE
for example.. the current changelog from here I suggest to move up to General because to me a changelog has nothing to do with a User Manual
See the DocumentationStructure as produced and updated it lucidchart
Problem
The current documentation is now compiling without any errors but going through the whole documentation you can see that there is a lot of redundant information and probably miss located documentation which should be moved and collected under an other topic.
Suggested Solution
Collecting missing issues from #3
There is the Idea of having it structured like that:
See the DocumentationStructure as produced and updated it lucidchart
Adding persons here:
@timlinux
@emirhartato
@wonderchook
The text was updated successfully, but these errors were encountered: