Skip to content

Meta Issue: High Impact Docs Targets #1 #46

Open
@ericsnekbytes

Description

@ericsnekbytes

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)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions