Skip to content
This repository has been archived by the owner on Sep 12, 2018. It is now read-only.

[docs] API links are broken #767

Open
ncalexan opened this issue Jun 26, 2018 · 1 comment
Open

[docs] API links are broken #767

ncalexan opened this issue Jun 26, 2018 · 1 comment
Assignees

Comments

@ncalexan
Copy link
Member

I think the initial landing of the docs/ directory and Jekyl integration landed with version numbers, but the landing page at https://mozilla.github.io/mentat/ is full of broken links because the version numbers are missing.

I'd like to see:

  • the links corrected
  • some kind of "latest" and "v0.x" incorporated
  • version numbers of the APIs to be at the top-level, like mentat/0.7/{swift,rust,...} rather than mentat/{swift,rust}/0.7
  • version numbers to agree with the main Mentat version number (so 0.7 throughout, or whatever is appropriate)
  • the stanza bundle exec jekyll serve --incremental somewhere in the documentation itself

@fluffyemily can you take some or all of those items? Thanks! (P.S. Your instructions worked well for me locally, and the site looks good!)

@ncalexan
Copy link
Member Author

Also, I see

docs/.jekyll-metadata
docs/_site/

that need to be added to the top-level .gitignore.

@fluffyemily fluffyemily self-assigned this Jun 28, 2018
ncalexan pushed a commit that referenced this issue Jun 29, 2018
* Fix broken API doc links

Create symlink for latest to point to v0.7.
Group APIs by top version number rather than individual

* Update swift and android version numbers to match Mentats

* Update documentation

* Update top level .gitignore to ignore docs site & metatdata

* Add README to help with building documentation site

* Address review comments @ncalexan
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants