adlnet / xAPI-Spec

The xAPI Specification describes communication about learner activity and experiences between technologies.
https://adlnet.gov/projects/xapi/
898 stars 404 forks source link

Fix formatting #1035

Closed aakoch closed 6 years ago

aakoch commented 7 years ago
  1. If an anchor tag was immediately above a line with a header, it wasn't rendered correctly, so I added lines.
  2. There were some anchors that weren't closed, causing some issues.
  3. Fix typos (misspellings)
  4. Fix link on page
  5. Add space between hash and character for proper formatting
garemoko commented 7 years ago

I believe items 1 and 2 are fixed by #1034.

The other typos and link fixes should be PRed to the dev branch instead of master.

Item 5 isn't covered by #1034 and does need to be addressed in master. It also needs to be addressed for the part one header and 'How to Contribute' in CONTRIBUTING.md (which you addressed in #1036)

andyjohnson commented 7 years ago

@garemoko 's PR was larger so I went with that one first. There are now conflicts. After this round of merges, I'll update dev (since there haven't been any PRs to it) with the markdown fix so we don't have to go through that again. Thanks so much for helping on this, but if you could work from the new merge, I and we would appreciate it a ton!

garemoko commented 7 years ago

I believe the only bit of this PR we need to keep is the typos like: https://github.com/adlnet/xAPI-Spec/pull/1035/files#diff-e357caff41f2a13c998b2f789a7820b5R1931. Those should go into the dev branch anyway.

The other issues have either already been addressed or are covered in https://github.com/adlnet/xAPI-Spec/pull/1039

garemoko commented 7 years ago

The changes in this have now been merged into dev, so this can be closed.

creighton commented 6 years ago

We believe all of the changes have been addressed. If there are any issues, please feel free to reopen.