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

Centralize documentation for developers #2736

Open
jonwzheng opened this issue Nov 22, 2024 · 0 comments
Open

Centralize documentation for developers #2736

jonwzheng opened this issue Nov 22, 2024 · 0 comments

Comments

@jonwzheng
Copy link
Contributor

Motivation

In #2703, we are moving information from the (difficult-to-maintain, outdated, and generally out-of-the-way) Wiki page to the main documentation + other parts of Github that receive more visibility.

This includes:

Issue

However, there isn't really a home for dev-specific information. Specifically, information like:

Solution

Ideally we have something that's just out of the way from the users so they don't get confused, but also not tucked away so much that it gets forgotten. And there's always the mental load of having to think of yet another platform for information.

We could even actually just use the Wiki but keep it to just like 1-3 pages so it's more manageable.

I welcome anyone's thoughts on this!

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

No branches or pull requests

1 participant