Documentation for Tigase iOS Messenger (#5)
Andrzej Wójcik (Tigase) opened 9 years ago
Due Date
2017-04-13

Prepare end-user documentation for Tigase iOS Messenger.

Andrzej Wójcik (Tigase) commented 9 years ago

I think it will be best to prepare this documentation and documentation for TigaseSwift in subdirectories in project repositories in asciidoc, so I will be generated daily by Jenkins - (same as for Tigase XMPP Server).

Daniel Wisnewski commented 8 years ago

Documentation has been added to project under asciidoc, pom.xml builds using commands mvn clean install. Documentation will be in /docs

Wojciech please see that our docs.tigase.org picks up this directory and adds it to the page.

%andrzej.wojcik Please let me know if there's anything I have not covered in the application.

wojciech.kapcia@tigase.net commented 8 years ago

Project set in Jenkins, doc is live on our website: http://docs.tigase.org/#collapse-tigase-ios-snapshot-head.

Dan, please stick to the directory structure present in other projects, even it there is only single Guide - script processing docs uses it to pick up what's available and create page accordingly -- I've updated pom.xml to adjust resulting paths.

Daniel Wisnewski commented 8 years ago

Thanks %wojtek for the fixes, I copied the pom blind and edited, so some artifacts remained. I was unsure to use /src here since everything is swift and I didn't know if extra directories break build in the IOS environment. Should I move documentation to /src/asciidoc?

wojciech.kapcia@tigase.net commented 8 years ago

Dan, we could use Documentation to make things consistent (as in Swift library - vide issue #4235 and it's repository) or leave it as it (it works now) if it doesn't bother %andrzej.wojcik in terms of directory structure discrepancy.

Andrzej Wójcik (Tigase) commented 8 years ago

I would prefer to user Documenation as it would be the same for all our Swift/iOS related projects and project layout created by XCode suggest usage of capitalized names.

Daniel Wisnewski commented 8 years ago

Documentation moved to /Documentation folder, pom updated.

issue 1 of 1
Type
Task
Priority
Normal
Assignee
RedmineID
4236
Version
Version 1.0
Estimation
12h
Issue Votes (0)
Watchers (0)
Reference
tigase/_clients/siskin-im#5
Please wait...
Page is in error, reload to recover