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

End-user and contributor documentation #55

Open
idpaterson opened this issue Mar 13, 2015 · 1 comment
Open

End-user and contributor documentation #55

idpaterson opened this issue Mar 13, 2015 · 1 comment

Comments

@idpaterson
Copy link
Owner

The new workflow attempts to be fairly self-explanatory, but there will be some documentation needed. Most importantly so far, #53 will probably require the user to install PyICU in order to support localized date formats. It may be possible to provide an option in the Preferences menu to install that, but perhaps not if there is a lot of console interaction involved.

Landing pages will also be needed for post-authentication to welcome the user and provide a brief intro to the workflow. An index page will be needed for the gh-pages documentation since throwing users directly into Python code docs might not be the most helpful thing to do for non-contributors.

The documentation for the current version will be located at ./docs with a submodule referencing the repository's gh-pages branch at ./dist/docs. This allows contributors to have a prebuilt copy of the documentation for the current version without forcing an update to gh-pages until release. Jekyll will probably be useful for handling the combination of how-to pages and source documentation that I need.

@idpaterson idpaterson self-assigned this Mar 13, 2015
@idpaterson idpaterson added this to the 0.5 milestone Mar 13, 2015
@idpaterson idpaterson removed this from the 0.5 milestone Jul 17, 2015
@idpaterson
Copy link
Owner Author

GitHub now supports hosting the repository's pages from a docs/ directory in the master branch. This will be much more maintainable than the submodule approach discussed above.

@idpaterson idpaterson removed their assignment Nov 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant