Closed fluffyemily closed 6 years ago
about
page right now is a Jekyll placeholder; maybe change it to something simple that's mentat-specific?A more general comment is on how keeping this stuff up-to-date. We have two tiers of content: hand-written docs, tutorials, guidance, etc (which are a well suited to live in the tree as long as we can remember to keep them up-to-date) and generated content (apis, docstrings, etc).
Generated docs are already out of date (I see 'error_chain' in the Rust docs, which isn't relevant anymore). Dumping bunch of generated files without any automation, or git hooks, or ... into the tree seems like the worst way to ensure they're up do date? Any change that involves any of the APIs, or docstrings, will need to included re-generated static files.
Could we host the generated files someplace where they're hosted and automatically updated from our release tags? Could we use something like readthedocs for the generated stuff, and link to relevant pages from our "overview" docs?
We don't have to figure that out in this PR, I suppose - as long as we periodically bump our documentation forward until we do... But if that's the path, let's at least file a follow-up.
Ah! I didn't read the linked issue #697! Ok, so the plan is to have travis auto-generate docs and commit them to the tree for us whenever commits happen? I didn't realize travis build bot has commit rights to the repository. Or were you thinking about having it upload generated files someplace?
I really think hosting this stuff externally is a better fit if we can help it, if we can find something that works for rust, java and swift.
I'm investigating readthedocs
for external hosting and will add it to #697 as a possibility
Landing this so we can iterate.
Steps to building docs locally:
cd docs
bundle exec jekyll serve --incremental
Basic website using Jekyll to create a site for accessing documentation, blog posts etc.
It doesn't look very pretty right now, but it is there. This will tie into https://github.com/mozilla/mentat/issues/697 to ensure that we keep the documentation up to date.