Reorganize Anteater API docs#33
Conversation
defer to club events page about event times, make some mildly opinionated tweaks
will fill out said contributor docs
this requires chair approval
also whitespace
how did we never do this before
alexanderl19
left a comment
alexanderl19
left a comment
There was a problem hiding this comment.
Looks good other than a few minor changes. Please add relevant descriptions to most pages.
|
@ecxyzzy iirc I approved the about section changes a while ago. Looking back I think it creates a bit too much fragmentation in our docs, as the content only really seems relevant to end users. Care to weight in on collapsing it back into the dev docs section. Also, I feel pages that veer more towards being marketing pages should be on the main site rather than the docs page. Since Kevin is reworking the site anyways, I imagine we'll be remove the empty brand section. |
|
Yeah I think having the page linked to by the attribution requirement be part of dev docs or even the website redesign proper would improve cohesion. It is documentation but it's definitely closer to marketing. Also not a fan of the attribution policy being a crosslink to the about section - IMO it should belong within dev docs. |
|
Regardless of our decision, we need to make sure we don't break existing circulated links. |
|
I mean that should be a given and also should be trivial, since the attribution link is an icssc.link shortlink. |
Descriptions are done. |
I think isolating the attribution policy from the docs would be unhelpful to someone who discovers Anteater API from that page. If it obviously inhabits a documentation site with a nearby about page the discovery flow seems more natural. I can see the argument that attribution is a immediate concern only of API-consuming developers and should be part of developer docs. I initially argued that since it is not strictly the technical requirements to use Anteater API, it should be in about. I am in favor of keeping it in developer docs. |
alexanderl19
left a comment
alexanderl19
left a comment
There was a problem hiding this comment.
Thanks for the changes. Just a small title / description change.
Preamble is now as follows, quoted below for your convenience: |
<!--- Provide a general summary of your changes in the Title above --> ## Description Finishes the work of icssc/docs#33 by: - Removing CONTRIBUTING.md; this was moved to docs. - Changing links consistent with that PR. **Please merge and deploy this simultaneously with icssc/docs#33 to avoid broken links**. ## Related Issue Closes #58. ## Motivation and Context As the issue mentions, the docs could use significant improvements in organizational clarity and beginner-friendly approach. ## How Has This Been Tested? No need to test visual changes of this nature. Corresponding docs pages were obviously tested. ## Screenshots (if appropriate): N/A ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ## Checklist: - [ ] My code involves a change to the database schema. - [x] My code requires a change to the documentation.
3 participants
Addresses icssc/anteater-api#58.
The new link flow is the boxed component of the following:
This creates several new pages; see that issue for a visualization of the pages as they currently stand.
I am too tired to write out the new or old page list.
This PR moves some pages and thus requires chair approval - @ecxyzzy (chair) and @andrew-wang0 (API lead) may be interested in review.
Please merge and deploy this simultaneously with icssc/anteater-api#61 to avoid broken links.