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

Meta Issue: High Impact Docs Targets #1 #46

Open
ericsnekbytes opened this issue May 31, 2024 · 0 comments
Open

Meta Issue: High Impact Docs Targets #1 #46

ericsnekbytes opened this issue May 31, 2024 · 0 comments
Assignees

Comments

@ericsnekbytes
Copy link
Collaborator

ericsnekbytes commented May 31, 2024

The Docs Working Group is engaged in a broad effort to identify and complete high impact docs targets, to benefit the entire Jupyter ecosystem. This issue is for feedback and coordinating work (like selecting targets and messaging suggestions/content edits).

Of the already-identified targets, many are Jupyter-wide resources that subprojects can integrate into their own docs sites. Work fits into these broad categories:

  • Foundational explainer docs.
    • These explain concepts, software and projects to newer Jupyter users
  • High level design documents
    • These explain the design rationale behind the design of Jupyter systems, for the benefit of both contributors, and power users (extension developers, core contributors, JupyterLab app authors)
  • "Get Help" resources
    • These collect and explain the various help outlets the Jupyter community offers to users (like the discourse, weekly meetings, github issues, etc.)
  • Improvements to existing docs

All of this work should help users better understand, use, customize and remix Jupyter software and standards, in accordance with the Docs Working Group's mission.

Current Targets:

  • What is Jupyter? (Document)
    • Clarify and disambiguate essential ideas and components of the Jupyter ecosystem
  • "Get Help" (Documents) [Issue] (described above) describing common Jupyter resources for users/contributors
  • History of Jupyter (Document)[Issue]
  • JupyterLab extensions page rewrite (In-progress)
@ericsnekbytes ericsnekbytes self-assigned this May 31, 2024
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