Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore the project documentation #13

Closed
9 tasks done
ForNeVeR opened this issue Aug 28, 2016 · 0 comments
Closed
9 tasks done

Restore the project documentation #13

ForNeVeR opened this issue Aug 28, 2016 · 0 comments

Comments

@ForNeVeR
Copy link
Member

ForNeVeR commented Aug 28, 2016

(Extracted from #11).

Help and docs directories store some HTML sources and compiled chm files. We need to decompile these files and store the docs in some more friendly manner. Also we'll need to import the current documentation from the preserved online copy.

  • Download a copy of the latest official online documentation and store into a repository
  • Decompile jabber-net.chm file, extract the information from it, and delete the file
  • Extract the information from the docs directory and delete the directory
  • Extract the information from jabber-net-helpfilebuilder.shfb file (if any; probably there're namespace comments) and delete it
  • Merge all the documentation and store it in some modern format such as Markdown (in that case we'll want to use Jekyll or FSharp.Formatting to prepare the user-accessible documentation)
  • Decide if we want to store the API reference somewhere on site (it seems that everyone does that, even if I don't like it), and if so then how to do it (I've seen some great documentation examples made with F# and FSharp.Formatting)
  • Add a reference documentation
  • Actualize the documentation (after conversion it's still slightly outdated)
  • Publish the documentation online (probably using a GitHub Pages)
@ForNeVeR ForNeVeR mentioned this issue Aug 28, 2016
19 tasks
@ForNeVeR ForNeVeR changed the title Revive project documentation Revive the project documentation Aug 29, 2016
@ForNeVeR ForNeVeR changed the title Revive the project documentation Restore the project documentation Aug 29, 2016
@ForNeVeR ForNeVeR self-assigned this Aug 29, 2016
ForNeVeR added a commit that referenced this issue Aug 29, 2016
There was a unique howto.htm file, but it was a copy of the already
existing docs/howto.htm.
ForNeVeR added a commit that referenced this issue Aug 29, 2016
No useful information extracted.
ForNeVeR added a commit that referenced this issue Aug 29, 2016
Converted with the following command:

> ls | % { pandoc $_ -o ([io.path]::ChangeExtension($_, 'md')) }

and manually edited afterwards.
ForNeVeR added a commit that referenced this issue Aug 29, 2016
@ForNeVeR ForNeVeR removed their assignment Aug 29, 2016
ForNeVeR added a commit that referenced this issue Aug 29, 2016
There was a unique howto.htm file, but it was a copy of the already
existing docs/howto.htm.
ForNeVeR added a commit that referenced this issue Aug 29, 2016
No useful information extracted.
ForNeVeR added a commit that referenced this issue Aug 29, 2016
Converted with the following command:

> ls | % { pandoc $_ -o ([io.path]::ChangeExtension($_, 'md')) }

and manually edited afterwards.
ForNeVeR added a commit that referenced this issue Aug 29, 2016
ForNeVeR added a commit that referenced this issue Sep 2, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
ForNeVeR added a commit that referenced this issue Sep 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant