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.

Sign up for GitHub

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

Jump to bottom

[Doc] A Developer-Friendly Documentation Website #12

Closed
songkeys opened this issue Mar 13, 2023 · 3 comments
Closed

[Doc] A Developer-Friendly Documentation Website #12

songkeys opened this issue Mar 13, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@songkeys
Copy link
Member

songkeys commented Mar 13, 2023 •
edited
Loading

The title conveys the topic.

The current documentation is API-focused. We need an improved documentation website to help more developers to build the ecosystem.

Framework

Let us discuss the documentation framework first. I am currently considering nextra and vitepress. I am unsure, but nextra seems better. What do you think?

Doc structure

The following aspects come to mind:

  • Getting Started (of course, every doc requires this)
  • Guides
  • Characters
  • Notes
  • Links
  • Operators
  • Tips
  • ...
  • Newbie Villa
  • Op Sign
  • ...
  • Framework-specific guides ([Proposal] Framework Specific APIs #11 )
  • More...

Let me know if you would like to assist.
@songkeys songkeys added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Mar 13, 2023
@songkeys
Copy link
Member Author

songkeys commented Mar 16, 2023 •
edited
Loading

It's now on https://docs.crossbell.io

@sxzz
Copy link
Contributor

sxzz commented May 11, 2023

So can we close this now?

@songkeys
Copy link
Member Author

Sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sxzz @songkeys