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

Closes #767 - Fix Broken documentation links. #775

Merged
merged 6 commits into from
Jun 29, 2018

Conversation

fluffyemily
Copy link
Contributor

Addressing comments and issues raised in #767

  • Fix broken API documentation links.
  • Unify SDKs and Mentat under same version number.
  • Reorganize API documentation under version number.
  • Add latest symlink to point to the latest API documentation version.
  • Update .gitignore to ignore documentation related directories and files.
  • Add README to /docs to include local build instructions.
  • Update API documentation.

@fluffyemily fluffyemily requested a review from ncalexan June 28, 2018 10:18
@fluffyemily fluffyemily self-assigned this Jun 28, 2018
Copy link
Member

@ncalexan ncalexan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't working locally because the symlink you've created is absolute and references your local hard disk layout. There is a way to do symlinks in git, at least away from Windows, which should work with a relative link.

But even if I fix the symlink locally, the front page hyperlinks don't seem correct.

However, I was able to view all three documentation subsections, which was really helpful. I certainly see that our existing rustdoc isn't really helping anyone, so we'll have to work to improve that.

@fluffyemily fluffyemily requested a review from ncalexan June 29, 2018 11:08
@fluffyemily
Copy link
Contributor Author

So it turns out that you have to create the symlink inside the directory where the link it so be created in order for git to understand the link, so ln -s docs/0.7 docs/latest won't work but cd docs && ln -s 0.7 latest will.

Also, I stupidly didn't check in the correct editing of the link in index.md. Sorry.

Copy link
Member

@ncalexan ncalexan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks much better locally!

@ncalexan ncalexan merged commit da599c3 into master Jun 29, 2018
@ncalexan ncalexan deleted the fluffyemily/broken-site-links branch June 29, 2018 17:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants