add new api docs #48
add new api docs #48
Conversation
| <script> | ||
| // Redirect to new API documentation page: | ||
| window.location.replace("https://github.com/janpaul123/paperprograms/blob/master/docs/api.md"); | ||
| </script> |
There was a problem hiding this comment.
Maybe just delete this page entirely and link directly to https://github.com/janpaul123/paperprograms/blob/master/docs/api.md from the editor page?
There was a problem hiding this comment.
I was thinking we could do this to avoid dead links, yeah?
There was a problem hiding this comment.
Sure, though I doubt that many people will have this bookmarked since it's right there on the editor page. Let's at least then also update the link though, no need to link to an old page.
There was a problem hiding this comment.
yeah, maybe I'm on the only one who bookmarked it. just updated the editor link 👍
docs/api.md
Outdated
| colorName // "red", "green", "blue" or "black" | ||
|
|
||
| // these properties will be null if the marker is not on a paper | ||
| paperId, |
There was a problem hiding this comment.
Only noticing this now, but should we call this paperNumber for consistency? (This is outside the scope of this PR though, and no biggie anyway)
There was a problem hiding this comment.
ah, I pulled this from #43 (comment), but it looks like it was not implemented. fixed the name, and tagged as wip.
Preview the new markdown API doc here
This PR also redirects the original api page to it.