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

Writing style guide / glossary for Jupyter #45

Open
JasonWeill opened this issue May 22, 2024 · 0 comments
Open

Writing style guide / glossary for Jupyter #45

JasonWeill opened this issue May 22, 2024 · 0 comments

Comments

@JasonWeill
Copy link

Some terms in Jupyter projects, such as console and main work area, may not be familiar to less experienced users. We have a TypeScript style guide for code contributors, but not a writing style guide or glossary that defines the various parts of our application's UI and data model. Add a style guide or glossary to the documentation, wiki, or other persistent location. Include annotated diagrams, such as a screenshot of the Lab UI with callouts to individual elements.

It's fine to defer to an existing style guide, like the Fedora Documentation Style Guide or the Microsoft Writing Style Guide, for topics not specifically covered by the Jupyter writing style guide.

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