Join GitHub today
Fixes #4399 - Spacemacs documentation improvements and fixes. #5545
The prime goal of this PR is to fix the Spacemacs documentation links in the Table Of Content at GitHub and introduce reliable method of linking headings from different files that will work in the Spacemacs and both at GitHub and spacemacs.org web sites.
I fixed all the merge conflict except the last commit (it's too global and will constantly brake)
In the discussion #4399 we came to the conclusion that the solution shouldn't modify local files in the Spacemacs installation - they should be the same locally and at the repository. Also we decided to use toc-org for table of content.
Since we can't change how GitHub handles links, I made Spacemacs and spacemacs.org use the GitHub style links - they should always work at GitHub. Also I added some of my PRs that overlaps with this one and smashed bugs, fixed typos that I encountered while implementing the fix. They all are in the separate commits so it shouldn't be a problem.
I'll explain each of the commits
This is my magnum opus. Those lines shall be carved on my tombstone
changed the title from
Spacemacs documentation improvements and fixes.
[WIP] Spacemacs documentation improvements and fixes.
Mar 21, 2016
@syl20bnr I removed commits that change .org files and improved the formatting script.
This way the PR shouldn't get conflicts so often.
this pull request
Mar 23, 2016
One of my favorite PR, clean and fun to merge. Great job
Thank you !