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

Docs need reorganization #58

Open
3 tasks done
laggycomputer opened this issue Dec 18, 2024 · 0 comments · May be fixed by #61
Open
3 tasks done

Docs need reorganization #58

laggycomputer opened this issue Dec 18, 2024 · 0 comments · May be fixed by #61

Comments

@laggycomputer
Copy link
Member

laggycomputer commented Dec 18, 2024

Expected Behavior

A reorganization is needed of existing official documentation around Anteater API and, tangentially, what remains of PeterPortal API.

Current Behavior

Docs for Anteater API are quite disorganized right now.
See a rough graph of the links around the docs:

flow

Possible Solution

The pages could be reorganized as follows:
ideal-flow

This plan has already been disclosed to two Anteater API team members.
It requires PR(s) in docs and this repo as well to complete this reorganization.

These PRs will be linked when created.

  • Update PPAPI landing (if possible) probably an under-the-table patch if at all
  • New docs pages
  • Update other links (REST reference, README, any others)

Steps to Reproduce (for bugs)

N/A

Context

N/A

Your Environment

N/A

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 a pull request may close this issue.

1 participant