Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Corrected link for Anteater API in the README in the apps/backend folder #1143

Merged
merged 1 commit into from
Feb 6, 2025

Conversation

charlieweinberger
Copy link
Contributor

Summary

In the readme in the apps/backend folder, there is a link to the developer docs for Anteater API. The current link is https://docs.icssc.club/developer/anteaterapi, which is the wrong link (try it, you'll get a 404). This pull request just replaces that link with the correct link, which is https://docs.icssc.club/docs/developer/anteaterapi (notice the /docs/ in the middle). Yes, I literally only added 5 characters in this pull request.

Test Plan

  • Verify that the link routes to the correct URL now.

Issues

There (probably, I haven't checked) isn't an issue for this, but I figured it'd be easier to create this PR right now instead of letting you guys know in discord or making an issue, since its literally just the smallest thing.

Copy link
Member

@KevinWu098 KevinWu098 left a comment

Choose a reason for hiding this comment

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

LGTM

@KevinWu098 KevinWu098 merged commit fa89c29 into icssc:main Feb 6, 2025
1 of 4 checks passed
@laggycomputer
Copy link
Member

This should probably be the about docs, not the developer docs.

@charlieweinberger charlieweinberger deleted the patch-1 branch February 6, 2025 05:47
@KevinWu098
Copy link
Member

This should probably be the about docs, not the developer docs.

Elaborate?

@laggycomputer
Copy link
Member

https://docs.icssc.club/ as a whole is structured into four categories. In API, we use "about", "developer", and "contributor". We point people to "about" as a landing page because it contains more general information about Anteater API. Developer docs are more in the "get started with actually using this" direction and are more narrow. If you're potentially informing someone of the existence of AAPI for the first time, the about docs are more appropriate.

@KevinWu098
Copy link
Member

KevinWu098 commented Feb 6, 2025

https://docs.icssc.club/ as a whole is structured into four categories. In API, we use "about", "developer", and "contributor". We point people to "about" as a landing page because it contains more general information about Anteater API. Developer docs are more in the "get started with actually using this" direction and are more narrow. If you're potentially informing someone of the existence of AAPI for the first time, the about docs are more appropriate.

I'd note that if someone is already rifling through the backend directory of AA, they'd perhaps rather be directed to the developer docs rather than the general docs.

I don't have a particular preference either way, frankly, so if you feel strongly about it, feel free to open a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants