Skip to content

Improve our community and contribution guide for new users #46

@choldgraf

Description

@choldgraf

We had a lot of helpful conversation about onboarding new people and helping them navigate the project. Here are the main things that stood out.

Paint points

  • It is confusing to know whether executablebooks or jupyterbook2 is "the main spot" for the project.
  • It's hard to know the 'one place to look' to navigate the project.
  • People don't know what a team compass is.

Implementation

  • Extend the team compass to be the "source of truth" contributing guide
    • Add sections about navigating project repositories
    • "Where to add docs, where to work on X type of code, etc"
    • Document a "what is the team compass" section
  • In mystmd: Lift anything that's not myst-specific to the contributing guide
  • In Jupyter Book: replace the "community" section with a team compass section (they can share navigation bars)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions