# napari documentation working group

- Zoom meeting: https://numfocus-org.zoom.us/j/85478605022?pwd=JAIWzoSLu3bkxbWaYFpV80tyR6lIS9.1
- Link to this HackMD: https://hackmd.io/10DKrIMhREmk9sa_QRirlg
- Project board: https://github.com/orgs/napari/projects/31

## 2024-11-07/08

### Agenda

- Needs review:
- [Add initial UI sections docs pages and script for generation #114](https://github.com/napari/docs/pull/114)
- [Add a release action #497](https://github.com/napari/docs/pull/497)
- [Add linkcheck step to be run once a week #474](https://github.com/napari/docs/pull/474)
- [name=Peter] I'd love to touch base on
- [ Create documentation for running napari on remote/browser based desktops #29 ](https://github.com/napari/docs/issues/29)
- [ Update napari-xpra docker docs #268 ](https://github.com/napari/docs/issues/268)

I'd like to finally get started on remote usage of napari via either:
- xpra
- jupyter-remote-desktop-proxy
trying to figure out how to get started in relation to https://napari.org/stable/howtos/docker.html
- We should have a signpost for "running napari remotely" that also points to the napari in docker guide
- Two concerns: writing a guide for creating custom images; writing a guide for users to use a pre-set image
- prioritize jupyter over xpra
- Running napari remotely
- Using napari remotely with jupyter
- Using napari remotely and connecting to remote resources/GPU/AWS etc
- Building your own napari docker image
- Colab?
- using napari in binder? -> workshop template has some stuff
- Who is this doc for?

- Blog: summarize survey notes
- survey report
- survey data
- draft report in #annual-survey
- Melissa will draft a blog post about the survey
-

---

## 2024-10-24/25

### Agenda

- Release action to automatically update docs folder, stable symlink and version switcher: https://github.com/napari/docs/pull/497
- Please leave feedback!
- PRs to review:
- [ Add community calendar link to landing page #504 ](https://github.com/napari/docs/pull/504)
- [ Update widgets guide to point to napari-plugin-template #362 ](https://github.com/napari/npe2/pull/362) - instead of cookiecutter-template (this is in npe2)
- [ Update docs to remove flake8, isort mentions and add ruff #502 ](https://github.com/napari/docs/pull/502)
- [ Highlight Jupyter option in gallery examples #503 ](https://github.com/napari/docs/pull/503)
- [ Add linkcheck step to be run once a week #474 ](https://github.com/napari/docs/pull/474)
- [ Add initial UI sections docs pages and script for generation #114 ](https://github.com/napari/docs/pull/114)
- Project: update plugin docs
- There are a number of issues open for updating the plugin docs: https://github.com/napari/docs/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen+plugin
- Melissa can work on this next.
- Blog?
- [name=Melissa] I'll be annoying :D

## 2024-09-26/27

### Agenda

- Add napari docs build action to release process, including creating folder for new release in napari.github.io and updating symlink (think about version switcher) (in progress)
- Issue: https://github.com/napari/docs/issues/490
- First PR: https://github.com/napari/napari.github.io/pull/417
- Second PR: https://github.com/napari/docs/pull/497
- There will be a third PR to make the same changes to the napari/napari build and deploy docs action.
- Blog: Juan will get in touch with the Vesuvius challenge folks, but we want to have a blog post first.

### Triage!

- https://github.com/napari/docs/issues/291 and https://github.com/napari/docs/issues/295
- Preference to moving docs requirements to napari/docs and having `napari[docs]`
- https://github.com/napari/docs/issues/82
- Review: https://github.com/napari/docs/pull/498
- Review: https://github.com/napari/docs/pull/483
- What is left to do here? https://github.com/napari/docs/issues/18
- Can this be closed? https://github.com/napari/docs/issues/127
- Can this be closed? https://github.com/napari/docs/issues/176
- What is the documentation request here? https://github.com/napari/napari/issues/6093
- I think this is solved, can we close? https://github.com/napari/napari/issues/5221

## 2024-09-12/13

### Agenda

- [name=Melissa] [Docstrings maintenance plan #7221](https://github.com/napari/napari/issues/7221)
- Look at scikit-learn
- Maybe have a discussion at the Scientific Python discord/discourse
- [Google season of docs](https://developers.google.com/season-of-docs/docs/timeline) could be an option for funding this work next year
- Add napari docs build action to release process, including creating folder for new release in napari.github.io and updating symlink (think about version switcher) (in progress)
- Will include [ Deploy action should deploy to both the release folder *and* dev on release #486 ](https://github.com/napari/docs/issues/486)
- UPDATE: Issue created: https://github.com/napari/docs/issues/490
- [name=Melissa] [Update release guide #491](https://github.com/napari/docs/pull/491)
- JNI to review after meeting

#### Triage!

- [name=Melissa] [Centralized place for napari workshop materials #4531](https://github.com/napari/napari/issues/4531)
- we've decided that the workshop page fulfills all the needs we're likely to have in the foreseeable future. Too onerous to have a single page for everything.
- [name=Melissa] [Add makefile for docs in this repo #5222](https://github.com/napari/napari/issues/5222)
- closing as wontfix, docs requirements should be updated to the pyproject.toml
- [name=Melissa] [Add linkcheck step to be run once a week #474](https://github.com/napari/docs/pull/474)
-

### action items

- JNI: review napari/docs#491 release guide updates
- JNI: write in #4531, decision from docs working group: this should be an opt-in link-out page as we have already, with encouragement to upstream changes to template if needed.
- JNI: close #5222 as wontfix, docs on building docs are at https://napari.org/stable/developers/contributing/documentation/index.html
- Melissa will submit a PR to napari-workshop-template repo with a better caption for the workshops listing page and add a note to the "build your workshop" to upstream stuff and add your workshop to the list
-

## 2024-08-29/30

### Agenda

- [name=Melissa] [Docstrings maintenance plan #7221](https://github.com/napari/napari/issues/7221)
- [name=Melissa] ~~[Add short guide on updating constraints files #460](https://github.com/napari/docs/pull/460)~~ Merged
- Add napari docs build action to release process, including creating folder for new release in napari.github.io and updating symlink (think about version switcher) (in progress)
- Will include [ Deploy action should deploy to both the release folder *and* dev on release #486 ](https://github.com/napari/docs/issues/486)
- UPDATE: Issue created: https://github.com/napari/docs/issues/490

#### Triage!

- [name=Melissa] Can we close ~~https://github.com/napari/docs/issues/218 and~~ https://github.com/napari/docs/issues/66 now that we have the announcement banner at the top of the pages?
- Issue updated
- [name=Melissa] [Centralized place for napari workshop materials #4531](https://github.com/napari/napari/issues/4531)
- Bump
- [name=Melissa] [Missing Documentation on "classic" asyncio #2851](https://github.com/napari/napari/issues/2851)
- Draga will take a look
- [name=Melissa] [Please explicitly specify the coordinate system. #1904](https://github.com/napari/napari/issues/1904)
- Issue updated
- [name=Melissa] [New standard napari screenshot. contest? #947](https://github.com/napari/napari/issues/947)
- Let's save this for a splash later
- [name=Melissa] [Add makefile for docs in this repo #5222](https://github.com/napari/napari/issues/5222)
- Bump

## 2024-08-15/16

### Agenda

- [name=Lucy] Document context keys (in `napari/_app_model/context/_layerlist_context.py`)

## 2024-08-01/02

### Agenda

- PRs to review/merge
- [Turn on warnings as error option for sphinx build #409](https://github.com/napari/docs/pull/409)
- Juan and Draga approved and merged, so we can update other PRs accordingly
- [Remove post identifier when determine deploy directory #467](https://github.com/napari/docs/pull/467)
- Approved and merged main in, merged once it passed
- [Document command ID naming conventions #405](https://github.com/napari/docs/pull/405)
- Updated with main
- The PR is documenting the current state of things so we think it's worth it going in as is. Juan and Draga both think the broader discussion about what we want the convention to be warrants discussion, but we will open an issue in `napari` for this, as it might also require PRs to change the current IDs if we decide on something new.
- Opened [napari/#7148](https://github.com/napari/napari/issues/7148)
- [Add short guide on updating constraints files #460](https://github.com/napari/docs/pull/460)
- Juan updated with main, left comment
- [ Add script to create symlinks to duplicated videos #412 ](https://github.com/napari/napari.github.io/pull/412)
- Juan reviewed and approved
- [ Change version switcher pointer to stable in unversioned pages #413 ](https://github.com/napari/napari.github.io/pull/413)
- Juan approved

- Blog
- Can we plan a calendar?
- eventually yes, currently, ain't nobody got time for that! :joy:

### Action items

- [ ] Add napari docs build action to release process, including creating folder for new release in napari.github.io and updating symlink (think about version switcher)

## 2024-07-11/12

### Agenda

- PRs to review/merge
- https://github.com/napari/napari.github.io/pull/408
- https://github.com/napari/napari.github.io/pull/409
- Fixes for version switcher
- [Document command ID naming conventions](https://github.com/napari/docs/pull/405)
- [Update Makefile to be consistent](https://github.com/napari/docs/pull/448)
- [Plausible for blog](https://github.com/napari/island-dispatch/pull/8)
- [Plausible for docs](https://github.com/napari/docs/pull/453)

### Action items

- [ ] Add napari docs build action to release process, including creating folder for new release in napari.github.io and updating symlink (think about version switcher)
- [x] Update unversioned workflow to fix string pointing to version in pages
- [x] Update footer to replace zulip with "Chat" and replace image.sc with "Forum".
- Related: https://github.com/napari/docs/issues/218 and https://github.com/napari/docs/issues/62 and https://github.com/napari/napari-sphinx-theme/issues/12

---

## 2024-06-27

### Agenda

- PRs to review/merge:
- [Add troubleshoting about starting napari and LD_LIBRARY_PATH #433](https://github.com/napari/docs/pull/433)- Merged
- [Add links to blog and napari workshop template on navbar #429](https://github.com/napari/docs/pull/429)- Merged
- [DOC Add section on order of app-model init steps #432](https://github.com/napari/docs/pull/432)- Approved

- PRs and ideas for discussion:
- [Telemetry: Add sample code for collecting data and sample outputs #309](https://github.com/napari/docs/pull/309)
- [Redo of unversioned deployment workflow](https://github.com/napari/napari.github.io/pull/402)

### Action items

- Troubleshooting guide? For example, see [Add troubleshoting about starting napari and LD_LIBRARY_PATH #433](https://github.com/napari/docs/pull/433)
- Enable plausible for Island Dispatch
- Add zulip to "More" menu in navbar: "Community chat", update footer to replace zulip with "Chat" and replace image.sc with "Forum".
- Related: https://github.com/napari/docs/issues/218 and https://github.com/napari/docs/issues/62 and https://github.com/napari/napari-sphinx-theme/issues/12
- [[HUGE DIFF] Remove unnecessary files from repo #403](https://github.com/napari/napari.github.io/pull/403)
- For now, delete only the doctrees.
- Investigate a 404 page
- Look at https://docs.github.com/en/contributing/writing-for-github-docs/configuring-redirects#automatic-redirects-for-urls-that-do-not-include-a-version

---

## 2024-06-20

- [name=Melissa] Unversioned pages PR https://github.com/napari/napari.github.io/pull/393
- Summary:
- Docs build stays the same. We introduce logic (a github action) to copy over pages from latest over stable.
- Con: Potential inconsistency in theme, and potentially broken links. We could solve this by rebuilding stable with the new theme, if it is a blocker. (This should not happen often)

- Peter: we merged and fixed the action permissions. Alas, there is an issue with the CSS of the header and links in the left ToC are broken on Contributing, also the tabs on the homepage are wierd.
- [name=Melissa] "Contributing to napari" video https://hackmd.io/@melissawm/rk2OezzUR
- [name=Melissa] Blog policy https://hackmd.io/@melissawm/BybOWGfUC
- [name=Melissa] Add url to blog repo: https://github.com/napari/island-dispatch

## 2024-06-05

- Andy: rendering/slicing explanatory docs
- https://github.com/napari/docs/pull/424

## 2024-05-22

- Peter: was asked about example notebooks
- our gallery already does this!
- Melissa: we can tweak the ToC and messaging
- https://github.com/napari/docs/issues/422

## 2024-05-07

- Did a walkthrough of Peter's sprucing up of some napari workshop materials (https://thejacksonlaboratory.github.io/intro-napari-workshop/home.html)
- will make some PRs for the added or improved materials to the template repo
- consider if some of the material should be upstreamed to Viewer guide in napari.org
- Melissa has a PR to lift the pydata-sphinx-theme in our theme. Once they release, we can merge and update constraints in napari/napari
- unversioned pages PR https://github.com/napari/napari.github.io/pull/393 has approvals, Juan should push the button
- Blog/news: the implementation is ready to go, see: shttps://github.com/melissawm/napari-blog
- tracking issue https://github.com/napari/docs/issues/272#issuecomment-2066518978
- also see core dev thread `blog`
- blog will need a process too, who contributes? what goes there and how? review process?
- need a better decision making process for some of these bigger decisions: zulip poll and time period? once

## 2024-04-24

- [name=Peter] Sprucing up napari-workshop-template, e.g. https://psobolewskiphd.github.io/intro-napari-workshop/home.html
- I wrote up a walkthrough of my changes here: https://napari.zulipchat.com/#narrow/stream/298358-working-group-documentation/topic/meeting.202024-04-24/near/435259162

## 2024-04-10
- [name=Grzegorz] Docstring parsing
- problem with inheritance objects, update a docstring in base class but not in derived/inherited
- need checks to have consistency, but someone will need to update them
- https://github.com/napari/napari/pull/6816
- add the test to all layer classes, viewer/viewermodel
- Open tracking issue with list of classes to fix and the process

- [name=Peter] For building docs workflow, should we be installing [all]? [dev]?
- We tell people for local builds to install [dev]
- [name=Peter] docs requirements.txt vs. (or along side) napari[dev] install
- does a napari[docs] make sense?
- do we need all the heavy depends like torch, tensorstore?
- should all the docs stuff just be in napari/docs requirements, and we install napari[all]?
- see also: https://github.com/napari/docs/issues/396
- Initial thoughts: add napari[docs] and for now make it contain napari[testing] (the only part of [dev] that matters). The in the future we can decide to check what is needed or not, but that would be additional overhead, vs just using napari[testing] which gets tested all the time.

## 2024-03-27

- [name=Melissa] unversioned pages solution discussion:
- https://github.com/napari/docs/issues/86#issuecomment-2013475922
- Peter: strong #4 vote (Add copying logic to napari.github.io), as github action+script is likely easiest to get/understand/maintain
- [name=Peter] napari-theme release
- let's ask in core dev zulip, 48 hrs (end of week)
- push tag should work, nothing should break
- docs related project boards on github:
- there are multiple boards on the org level for docs and they mostly outdated, can we close or delete?
- let's make our own board on the docs repo -- and use this in docs meetings

## 2024-03-13
- [name=Peter]
- build/deploy workflow to stop uploading doctrees: https://github.com/napari/docs/pull/348
- maybe worth nuking the
- napari-theme: release? also pydata-theme pin, why is that again
- PR to readme:
- it's another place that will need to be updated if we change workflow/contributor/dev process!
- worth making a PR (Maybe Vince?) to the contributing docs
- priority issue large datasets, zarr, tensorsore: https://github.com/napari/docs/issues/350
- [name=Kasia] will write down some of what she has learned
- FAQ? How to trouble shoot advanced issues like performance?
- maybe a video/recorded webinar
- [name=Melissa]
- A bit stuck with unversioned pages. Should have _some_ update by the end of the week.
-

## 2024-02-28

## 2024-02-14
- from NA/EU community meeting:
- Grzegorz: make community calendar more prominant
- Task issue: https://github.com/napari/docs/issues/353

## 2024-01-31

- 0.4.19
- Pending items?
- App model docs https://github.com/napari/docs/pull/325
- To review
- "New from clipboard" https://github.com/napari/docs/pull/307
- don't want to expand scope
- Ref links PR https://github.com/napari/docs/pull/338
- approved, will merge
- TQDM PR https://github.com/napari/docs/pull/316
- requested review from Draga who wrote the napari code
- Revisit markdown linter? https://github.com/napari/docs/pull/54
- Needs an extra extension. Nice to have, but let's see if it requires too much effort
- Peter: my blocker on this is two issues here: https://github.com/napari/docs/pull/54#issuecomment-1829013471
- Unversioned pages: next in roadmap
- News/blog: next in roadmap (higher priority)
- Peter: Opening/Importing Files Guide/Tutorial for 0.5.0
- Issue: https://github.com/napari/docs/issues/44
- focus on importing, will double check and update title
- Related list of existing issues: https://github.com/napari/docs/issues/20
- review the two linked project boards
- make a docs project board

## 2024-01-17

THE NEW THEME--LET'S GO :rocket:
- [name=Peter] things to revisit:
- announcement banners
- get these for free with the new theme!
- goes on every page (napari.org for survey!)
- need copy, can see how it looks: https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html
- Option 1: Take the short <a href='https://bit.ly/napari-survey-2023-h' target='_blank'>annual napari survey 2023</a>! Your feedback is vital to ensure napari serves community needs.
- Option 2: The <a href='https://bit.ly/napari-survey-2023-h' target='_blank'>2023 annual napari survey</a> is live! Your feedback helps us serve the image analysis community in Python better.
- also get the versioning warning (if someone lands on 0.4.16 or such)
- Unversioned pages:
- https://github.com/napari/docs/pull/230
- scipy plans to use a redirect to latest, and have version warning
- risk is that if you open contributor guide and then click to API you will get dev API
- Blog/news enabled by this (https://github.com/napari/docs/issues/272)
- separate repo, jyputer book with same theme, on blog.napari.org
- link from docs
- no issues with versions, not gated by releases
- [name=Melissa] Layers https://github.com/napari/docs/pull/125
- agreed to handle properties/features in followup
- tagged ready to merge!
- [name=Melissa] Dual API/GUI docs exploration

## 2023-12-06

## 2023-11-22

- [name=Peter] Can we merge https://github.com/napari/docs/pull/274?
- We may need to add a note in the future to highlight the bundle installation instructions. We can also follow-up with a tabs PR
- [name=Peter] Markdown linter?
- https://github.com/napari/docs/pull/54
- This PR will have a lot of conflicts, so it might be easier to close and re-create with the myst plugin. But we want this
- [name=Melissa] https://github.com/napari/docs/pull/125
- We discussed the changes here and Melissa will move forward with re-creating images and videos.
- [name=Melissa] https://github.com/napari/docs/issues/280

## 2023-11-08

- [name=Peter] to discuss:
Walkthrough/Review theme PRs:
- https://github.com/napari/napari-sphinx-theme/pull/134
- should hold off till 0.5.0 due to single repo / double repo
- calender event issue, can fix on calendar side, see e.g. https://scientific-python.org/calendars/
- https://github.com/napari/docs/pull/267

last call: napari 0.4.19 docs cherry picking PR:
- https://github.com/napari/napari/pull/6384

revisit sphinx<6 pin (docs repo)
- https://github.com/napari/docs/pull/258
- Plan is to pin tags for now (no emoji tags) and then lift the pins with the new theme
- PR to pin tags

- [name=Dannielle] update on plugin/new content https://github.com/napari/docs/issues/153 on pause

## 2023-10-25

## 2023-09-26

- [name=Isabela] Design knowledge base? :sparkles:
- We may want to have general UX and design guidelines on the contributing docs, both for napari contributor and for plugin developers. More detailed information may be better suited for internal documentation.

- Check PRs, merge stuff!
- Check for 0.5.0 milestone in the docs repo since there will now be a 0.4.19 bugfix release
- Telemetry NAP -- should be merged and then further discussion?
- We may want to create a PR to fix the docs build instructions for 0.4.19

- [name=Melissa] Unversioned pages (draft): https://github.com/napari/docs/pull/230 (STILL IN DRAFT, need feedback)
- modification to deploy docs workflow, because it's just that one that needs changes
- setup and building doesn't change, neither does deployment
- everything will be deployed to `dev` and then we'll copy selected files to `stable` in `Copy permanent files locally`
- at present it will be developers and index
- the copied changes will be uploaded
- `copy files` job then uses a matrix to run the copy action one at a time (limitation of the used action)
- copy to the proper destination

- Consider relaxing Sphinx, see https://napari.zulipchat.com/#narrow/stream/212875-general/topic/napari.20sphinx.20dependency
- points layer properties vs. features
- update from Andy: https://napari.zulipchat.com/#narrow/stream/298358-working-group-documentation/topic/meeting.202023-09-26/near/393562552

- likely skipping Oct 11 meeting, due to conflicts

## 2023-08-16
- Melissa fixing the npe2 docs issue (https://github.com/napari/npe2/issues/308) :tada:
- [name=Melissa] CI documentation is in a PR: https://github.com/napari/docs/pull/220
- [name=Melissa] Unversioned pages (draft): https://github.com/napari/docs/pull/230
- modification to deploy docs workflow, because it's just that one that needs changes
- setup and building doesn't change, neither does deployment
- everything will be deployed to `dev` and then we'll copy selected files to `stable` in `Copy permanent files locally`
- at present it will be developers and index
- the copied changes will be uploaded
- `copy files` job then uses a matrix to run the copy action one at a time (limitation of the used action)
- copy to the proper destination

Action items
- Peter: napari zulip user groups: co
- Related: https://github.com/napari/docs/issues/206
- Team: look at PRs in github.io repo: https://github.com/napari/napari.github.io/pulls
- close anything that isn't relevant or suggest a migration plan
-

## 2023-08-02
- [name=Melissa] [Add markdown linter and formatter to pre-commit
#54](https://github.com/napari/docs/pull/54)
may lose `blame` but for docs does it matter so much?
- [name=Peter] start thinking/marking 0.4.19 milestone
- Melissa will add a note to developer docs about adding milestones to PRs before merging
- [name=Peter] circle back to https://github.com/napari/docs/pull/125
- the hold up: properties vs. features
- [name=Peter] merging stuff!
- https://github.com/napari/napari/pull/5988
- we did it!!

- [name=Dannielle]
- Where did this land? --> Need to improve documentation of napari sub-projects like npe2api and theme
- https://github.com/napari/napari-animation/pull/173
- [PR about Plugin Docs TOC](https://github.com/napari/docs/pull/203)
- Checking in about tracking Plugins restructure work
- Alister and Wouter-Michiel will be taking over running Twitter
- Ensure you can handle all potential response tweets (e.g. disgruntled users)
- Identify "who is speaking" in responses to users
- Use Twitter to announce bigger changes on some regular cadence
- [sphinx theme](https://github.com/napari/napari-sphinx-theme/issues/113)
- Ideas:
- Solution 1: Leave it as-is. Let the napari fork diverge from the pydata theme.
- Solution 2: Rebuild the theme to inherit the pydata theme (as proposed by Talley & Juan). This keeps consistent look-and-feel w/ napari hub while benefitting from future improvements to PyData (probably).
- Solution 3: Replace the theme w/ vanilla pydata theme (with basic changes to colors etc through theme config). Maximum maintainability. Inconsistent look-and-feel with napari hub (but stronger look-and-feel consistency with other pydata projects)
- Melissa has an alternative version almost done: https://melissawm.github.io/napari-theme-var/, https://github.com/melissawm/napari-theme-var
- Yay! Melissa is on this. Working towards solution#2
- Getting Started
- [Fixing Broken Link](https://github.com/napari/docs/pull/217)
- [Getting Started tile has the same name as the section](https://napari.org/stable/tutorials/start_index.html)
- Melissa will make a quick PR to made the tile names match the TOC and change the name of "Getting Started" to "How to launch napari"
- Changing docs WG link to non-CZI Zoom link
- Peter to figure out how to get credentials to change the link in the calendar

- [name=Melissa] WIP: Documentation for docs CI set up https://hackmd.io/@melissawm/Skq-9y1s2
- Should add to core dev docs
- [name=Melissa] Update on [calendar issues](https://github.com/napari/napari.github.io/pull/385)

Action items
- Peter: linter PR
- reach out to Andy/Lorenzo re: properties and features
- check other napari repos to improve documentation of napari sub-projects like npe2api and theme and make a meta issue on napari/docs
- Peter to napari core re: twitter/social media for surfacing ducs stuff
- Peter: [e-mail] credentials for calendar meetings

## 2023-07-19
- [name=Peter] conda/conda-forge, miniconda, channels, etc. instructions: should we clarify more? link out more?
[name=Melissa] lets make it more clear with an admonition, no drawbacks

Action items:
- Peter will make PR re: conda-forge
- Peter review the plugin restructure docs (Sean)

- [name=Melissa] Update: [napari-sphinx-var](github.com/melissawm/napari-sphinx-var) is mostly working, could use some css cleanup and calendar tests.

## 2023-07-05
- [name=Dannielle]
- [Tracking Plugins restructure work](https://napari.zulipchat.com/#narrow/stream/298358-working-group-documentation/topic/Tracking.20progress.20on.20the.20plugin.20docs.20restructure/near/371209434)
- [1st PR of Plugin docs to update TOC and landing page](https://github.com/napari/docs/pull/203)
- [name=Melissa] [Expose parts of the napari ecosystem in landing page](https://github.com/napari/docs/issues/191)
- [name=Melissa] napari.org is updated with the 0.4.18 release docs.

## 2023-06-21
- [name=Peter] impending 0.4.18 release :tada:
- Grzegorz is cherry-picking docs PRs BACK to napari/napari
- We can tag 0.4.18 in docs, to help him.
- Peter: eep, did I fully understand this correctly?
- Priority:
- viewer tutorial update
- install updates
- dev environment
- [docs contributing](https://github.com/napari/docs/pull/5), [docs preview instructions](https://github.com/napari/docs/pull/140)
- [plugin testing](https://github.com/napari/docs/pull/35)
- [virtual env](https://github.com/napari/docs/pull/50)
- [homepage! ? !](https://github.com/napari/docs/pull/102)
- milestones in the docs repo
- Melissa: github.io needs a folder 0.4.18 where stable points to
- 0.4.18 branch on napari docs? build together, docs go to github.io
- worst case, build locally and commit directly
- [name=Dannielle] Plugin Docs Restructure: https://github.com/napari/docs/issues/153
- PR breakdown proposal was reviewed by Draga, Dannielle, and Peter
- Look out for PRs in the coming weeks
- [name=Dannielle] FYI CZI is leading an effort to build workshop content for CZI plugin grantees
- Topics include software development best practices, open source citizenship, plugin modularity, etc.
- Content will be shared on napari.org as workshops or integrated into existing content
- [name=Dannielle] napari Roadmap: https://github.com/orgs/napari/projects/24/views/1
- Is it linked on napari.org yet? No, but it should be!
- [name=Melissa] napari-sphinx-theme
- https://github.com/napari/napari-sphinx-theme/issues/113
- https://github.com/melissawm/napari-theme-var
- Matplotlib: depend on the sphinx-theme and then have extra stuff
- Melissa: worked on it to try it and it looks great!!
- Merged new homepage! :fireworks:
- Decided: merge ready-to-merge pr during meeting! :tada:

Action item:
- Format of road map on [napari.org](https://napari.org/dev/roadmaps/index.html)
- Peter will touch base with Grzegorz about docs

## 2023-06-07

- On 2023-05-23 we discussed wanting to revisit:
- Homepage redesign: https://github.com/napari/docs/pull/102
- theme is the blocker? need a point person from core-devs to be active in that repo -- sustainability grant??
- commented on the PR: https://github.com/napari/docs/pull/102#issuecomment-1581380847 based on plausible data, mobile is not a big issue, so maybe best to go forward.

- docs PR regarding plugin development: https://github.com/napari/docs/pull/50
- commited Draga's suggestions, we'll put of any npe/npe2 issues until npe is removed
- _action_ double check link to the testing tutorial
- napari.org feedback mechanism: https://github.com/napari/docs/issues/62
- requires more engagement, and potentially changes to the theme
- integration with plausible.io if lightweight might be worth doing
- current issues are created by a small set of people, may be reasonable to start with link to create an issue and later open it up to something that doesn't require (github) login
- User surveys and research
- Peter: yes to DOI/public place for report
- Peter: maybe link in community
- Kandarp to email core devs (update: deferred until joint survey)
- Stable vs. dev docs -- aspects that are not from new release, but updates to existing
- how to make it quicker/more accessible
- can we do docs relaeses of 0.4.17 or such?

## 2023-05-23

- [name=Peter] plan to do some work on the core dev and contributor guides (with Kevin)
- we're looking at adding code owners, update guidelines for reviewers, add a copy-edit group to improve PR title/merge/commit copy
- Suggestion: https://numpy.org/doc/stable/dev/development_workflow.html#writing-the-commit-message
- Sean has been active with great new content :tada: do we want to use tiles more liberally to improve nagivation of long documents (e.g. docs contributor guide)
- FYI Sean Martin's issues
- [Plugin Developer Docs restructure](https://github.com/napari/docs/issues/153)
- Connect with Gregorz for feedback
- technical elements check for accuracy (e.g. npe2, etc)
- Write out proposal for how to break up the work into smaller PRs
- Peter to review and give a round of comments
- [how to build docs on Windows](https://github.com/napari/docs/pull/158)
- CI error: Melissa to review
- widget UI error?
- similar to an issue found in the napari repo
- [PR merged to fix issue with napari upstream](https://github.com/napari/napari/pull/5862)
- Does this fix need to be ported to the docs repo?
- Peter to connect with Gregorz about the PR
- *Edit: this is fixed now by Grzegorz :heart:*
- [napari docs contribution guide](https://github.com/napari/docs/pull/157)
- Gregorz needs to approve
- Peter to mention to Gregorz
- [debugging guide for plugin developers](https://github.com/napari/docs/pull/161)
- Peter and Gregorz will review the PR
- [name=Melissa] https://sphinx-design.readthedocs.io/en/latest/
- [name=Melissa] Version warning banner, PR 1/3 https://github.com/napari/napari-sphinx-theme/pull/132
- will require release of theme
- core developers are responsible for the napari sphinx theme
- Peter to bring up discussion with the core devs about who should maintain this
- Need to select a code owner who knows HTML/CSS
- Need to also have a general conversation about who owns each code repo
- [name=Melissa] [Using Dask and Napari to view and process 100µm resolution human brain dataset](https://github.com/napari/docs/pull/132)
- How to move forward?
- The main problem is this example is not runnable on CI because of a very large dataset required to execute the example.
- Who can make a decision here?
- *Edit: Peter poked in zulip and Juan chimed in on the PR*
- [name=Dannielle]
- [structure of the docs working group](https://github.com/napari/docs/issues/120)
- To discuss at the next docs working group meeting:
- [napari.org feedback mechanism](https://github.com/napari/docs/issues/62)
- maintenance plan; integration with plausible?
- usage of feedback
- [homepage reorg](https://github.com/napari/docs/pull/102)

## 2023-03-29

- [name=Melissa] [Layers documents update](https://github.com/napari/docs/pull/125)
- Content is all Nadalyn's :tada:
- Could videos/images be updated in later PR?
- PS: Yes, probably. The text is still correct.
- DDP: Agree, I think videos can be separate PR.
- PS: Did suggest a bunch of keybindings, but we need to surface them better. Not sure where they could go, think there's an issue open, but I think it's important we update.
- MWM: See https://github.com/napari/docs/13
- https://napari.org/stable/guides/preferences.html -> could probably be made into a how-to, maybe even moved out of in-depth explanations.
- DDP: We need more human text for some of these preferences too - there's not enough context for some of these for the autogenerated settings for it to be useful
- [PS] would be great in general to think about moving some stuff out of how tos/in depth/community because it's relevant mostly to people who want to extend napari
- [DDP] I really feel like tags are the solution here
- [MWM] yeah one big limitation is that you can't list the same document multiple times in the TOC. So even if something belongs in two places, we can't do that. Tags would be a solution. I think we should have someone with a background in information architecture look at the docs and come up with tags.
- [DDP, PS] Yeah, agreed.
- [PS] Maybe some of the sustainability grant could be used for this
- [DDP] Missing architecture docs, really needed for onboarding and contributors
- [NM] Usually the way I've done this is interviews with engineers and then I go away and do most of the writing, and ask for clarification as it's needed
- [PS] Yeah the bus/circus factor is critical right now. We don't even know who knows some stuff
- [DDP] At the very least we should soon have a rough idea of who knows what and who is happy to review what, so maybe we can start with that - if 6 core devs say they're happy to review e.g. qt stuff, then maybe that's not as much a priority as if only 2 people are happy to review e.g. vispy stuff
- [name=Melissa] Version warning banner: https://github.com/napari/docs/issues/82
- Should I move forward with this?
- [DDPP, PS] Yes please!
- [name=Melissa] https://github.com/napari/docs/pull/128
- Make PR numbers into links in the release notes. Thoughts?
- It works, making it prettier depends on an update of the napari-sphinx-theme (see https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/theme-elements.html#link-shortening-for-git-repository-services)
- [DDP] Very cool!
- [MWM] Next steps is enabling for different repos not just napari/napari
- [name=Peter] Re: working groups: plugins should be put on hiatus. Architecture is "fine." Next steps?
- We need to update governance for the docs wg at least. It would make sense to have Peter as co-lead as that would also cover more timezones.
- We can continue rescheduling a rotating meeting in the zulip thread.

## 2023-03-15

- [name=Melissa] Noted that the working groups page is outdated.
- Made Task issue to open a discussion about this
- [name=Melissa] https://github.com/napari/docs/issues/82
- [name=Melissa] backporting to rendered docs will need to be manual
- [name=Melissa] (need to look at backporting in general; bot? meeseek by Matthias)
- [name=Peter] very useful to have this, willing to help
- [name=Peter] PR https://github.com/napari/docs/pull/119 can you explain like I'm 5
- [name=Melissa] it's to make issues/prs links in the release notes!
- [name=Dannielle, Peter] we may want to consider alternating timezones!

## 2023-03-01
- [name=Melissa] Request for feedback: [Add documentation mapping visual UI with code structure, modules and classes #93](https://github.com/napari/docs/issues/93)
- Related PR: https://github.com/napari/docs/pull/114
- Peter: definitly think it's useful, on my TODO to give more feedback.
- [name=Melissa] Home page: https://github.com/napari/docs/pull/102
- Peter: it's growing on me. Video works now, which helps. Wish it had color!
- Nadalyn: strong positive! video is great!

- version switch/outdated version banner
- stalled PR on the pydata theme https://github.com/pydata/pydata-sphinx-theme/pull/780
- option would be to just port the change to our repo directly, rather than wait
- discussion (or lack there of) at #82 napari docs https://github.com/napari/docs/issues/82

## 2023-02-15

- Circle CI PR merged but the credentials aren't enabled?
- Draga will reach out to Juan at some point today to get the permissions configured
- Mel on her own repo: go to circle ci, sign up with github, which repo do you want to activate circle CI for, select napari docs, and that should be everything
- ping Melissa when that's done
- Feedback mechanism for [napari.org](https://github.com/napari/docs/issues/62)
- Melissa's been looking in to it: is it common to open source projects?
- Usually see thumbs up/down only in commercial projects
- CircleCI they have a big box with "help make this document better"
- CircleCI/GitHub/hack have a yes/no was this article helpful, No opens up create an issue option for circleCI, GitHub has a small form you can fill out or directly go to the repo to make a contribution.
- NetGate/pfSense have stars instead of thumbs up/down
- react also has yes/no and edit this page
- Hypertables takes you to a very specific issue template with dropdowns and questions
- Draga big plus to form, doesn't see much point to the thumbs up/down thing
- Peter clicks the thumbs up because he likes positive feedback, but obviously won't open an issue for positive feedback
- Kandarp: we could front load some of the thumbs up/down by asking a more useful question instead of just an abstract thumbs up/thumbs down. Will it make multiple issues about same page?
- Melissa: yes new issues for each feedback point, but I don't **think** that's going to be a big burden, to maintain the issues. We could be wrong but I don't imagine most people will open issues. Other options is instead of sending you to create new issue, they send to the list of issues. GitHub has the option of providing more information directly through the website form.
- Peter: re. the audience, this is napari.org so we'll have users of all sorts of levels. Contributing to the docs yeah you should go issue on github, but some users won't have github accounts or won't want to open an issue, so something simple like the github one is really nice
- Kandarp: the survey has a question about what community people know about and use, so that might have some info. Only 5% of people are unfamiliar with/never use GitHub in connection to napari.
- Melissa: yes but we probably want those people's feedback more, and they are less likely maybe to open an issue at all
- Draga: yeah I think ideal would be really to have the small feedback box + link to open issue
- Melissa: will update the issue with options so we can all weigh in.
- Kandarp: Matlab had the stars with a text entry box
- Peter: maybe we can not let them submit with an empty box?
- Melissa & Draga didn't like that :laughing:
- Draga: still don't feel like we want a rating because we don't necessarily want to know the positive stuff, we just care if something wasn't useful
- Kandarp: well, it could be useful to have if enough people did write what they liked
- Peter: one takehome message is that right now we do have a very github savvy audience, so maybe we should just have a github thing and expand to more options
- Kandarp: could we know if people click but then don't open issue? If lots of people click but we get no issues that's an indicator that maybe they don't want to use the github template
- Melissa: we do have a fair bit of analytics through plausible so we could find out the clickrate. All of the solutions are fairly simple to implement, it's the larger research question that needs to be answered: where is it stored, what do we ask, how often do we review it
- Home page discussion
- Draga: I definitely think we should be in favour of merging asap and iterating, because what we have now is just not good.
- Melissa: I've been working on a little animated carousel. It's not ready yet but it's kinda working. Would need a PR to sphinx-design and then we could use the regular cards
- Everyone loved that
- Draga: this is awesome, and would be cool for it to be able to link out to examples etc.
- Peter: I was initially not hype on the rapid merge, but I think Draga's convinced me because I really want the cards and the cards are way better than what we have. Would much rather have the carousel than a video because it's often hard to figure out what's going on in a video
- Melissa: talking to matplotlib folks about how they keep the theme in sync with the pydata-sphinx-theme and nobody seems to really know, they set it up at some stage and only one person knows how it's set up
- Peter: working with some folks who work with napari plugins, and they have to shuttle things back and forth between imagej. Some transition guide of basic imagej functions and what their equivalents are in napari or napari + plugins would be huge.
- Could do some console + napari core + plugin suggestions
- Really basic things like counting cells etc. are not trivial to figure out
- Peter: I would love to add some python stuff in there too, or is that too much
- Draga: I think if there's any combo of napari core + plugins + simple console code that can achieve the same thing as you could achieve in an imagej workflow, we should demonstrate that. We can always add easier instructions when we have them
- Peter: collaborator was going to open an issue but hasn't yet
- Dannielle: I think open an issue and crowdsource what people are missing would be the best bet
- Peter: there are imports, we'd have to consider if we made some basic imports available by default
- Draga/Melissa: would advise against, explicit is better than implicit
- Peter: will open an issue to track
- Dannielle: can you please tag Nadalyn and me (and Kandarp)!
- Melissa: away next week, back on 28th Feb
- Draga: away March 1st - March 29th

## 2023-02-01

- Dannielle: Where should [workshop](https://docs.google.com/document/d/19mNdeYYJfFm3eNRIOwwWU1FBz_GbiJkCRv-uXNqVocY/edit?usp=sharing) go?
- MW: could go on napari workshops with the links to external workshops. Make it a submenu and then list 'internal' workshops
- DM: workshop for using napari for a GUI focused user, but with a bit at the end about using from ipython. Initially given at UC Berkeley
- PS: in most places we say conda forge, but that was miniconda - is this a concern?
- JNI: There is a lot of confusion here because of an exploding ecosystem. Miniconda is developed by anaconda but by default it doesn't use conda forge. We probably want to change that to miniforge (lol) which uses conda forge by default. If you install miniforge instead you can remove `-c conda-forge`
- PS: is one of them more friendly? I'm pretty sure I have miniforge but is miniconda somehow more useful?
- JNI: nope, not really, just the default channels change.
- PS: if the defaults are more friendly, we should probs just use miniforge. Might be worth looking at the environment creation PR too
- DM: Installing miniforge would still give them access to conda as an environment manager?
- JNI: yes. Does this live anywhere else or just in the google doc?
- DM: in the google doc so far because it links out to so many places and it was easier to keep things in one place.
- JNI: I think it should go in the list of workshops, and link internally instead of externally
- PS: based on that outline I think it looks really great. There is part of a mission statement that talks about napari being a gateway to python and it was for me, so I think this workshop would make it so much easier for someone like me to show it to students and coworkers and you can see a path to doing more complex things, and you appreciate that running a script twice is easier than going through the menus etc. Would be awesome to have this on the site
- DDP: I think this should go into the workshop template
- DM: yep, that's basically the plan, we're converting it to web content at the moment.
- PS: for me sometimes it's hard - this seems so valuable that maybe it should be surfaced higher as a tutorial or a get started, because it really covers from the beginning to the end. A user may not realize it's a workshop they're looking for. Will someone who's looking for this even think to go there?
- JNI: in my home page PR I did note that the getting started needs a refresh, so I do like that idea. I'd like two getting started - one for experienced users and one for less experienced. This is exactly what we'd want for a new user getting started
- DM: it would be good if it could live statically on napari.org. Could we incorporate it into the existing napari quickstart and just highlight that it's for new users?
- MW: it may be valuable to have the content in different forms. For example, keep the workshop fully together as something to follow through, but *also* as content on the page, whether via hyperlinks or a summary. There probably is content there that we should lift up to the quickstart
- JNI: yeah we should one, just put it at the top of the workshops, and then in subsequent PRs we can rearrange other stuff
- MW: also just one final note, you mentioned a carousel in your new home page PR, and some people didn't even know we had that page, so maybe that is something we can think about for a carousel
- PS: a lot of installation stuff. maybe installation should be separate from usage, even in our quickstart, because we do duplicate that sorta stuff a lot. I love the tiles though! We can have dedicated installation stuff
- DM: Also happy to make a PR/issue on quickstart so we can discuss what we want and would like to see, and then we can separately work on getting the workshop published
- Dannielle: starting a new community focused group for improving documentation across all projects (napari.org, napari hub, plugin devs etc.)
- DM: where is the best place for us to make sure the community is involved and informed about work going on in this group?
- DDP: I would say this meeting and the zulip chat for this working group would be the two places. Whether folks from this new group also join this meeting, or whether just one person shares out, but this would be the forum where I would expect to see updates
- MW: Should these updates be done at community meetings as well?
- JNI: in theory yes, but I've been poor at that too. We are looking at revamping the community meetings because they're not very sucessful
- MW: We actually have [a doc](https://learn.scientific-python.org/maintainers/meeting_types/) on the different types of meetings which might be useful
- PS: Yeah I feel like after the repo split, we have less input from the wider group into the docs repo and that's been a bit frustrating, we haven't really seen much discussion about that in the community meetings. As core devs we need to be more aware of what's going on in the docs and sharing those out with the broader community.
- DM: I'm planning to use this meeting to keep folks informed, and then I will take the lead from y'all on whether I should join a community meeting to share out more
- JNI: I think we should have a link that people can click to open an issue or PR for a given page
- MW: we have an issue for that, and that's a q that I had for today: we could have for every page a snippet in the footer or below the page that has 'give feedback' and it takes people to the list of issues or a new issue. Do we need design for that, or do we just want to have the plain text? The banner, an admonition?
- JNI: I want it to be not intrusive so I would just stick it in the footer. Well... we don't have a footer per page... I noticed our issue template for docs is not updated? Our template should ask for a link to the relevant page. Probs not actually the footer, just at the bottom of the bottom of the content
- MW: the template has new content, bug , and the bug does ask for a link
- PS: There might be an open PR about this but it took me a while to figure out how git, make etc. works, but you can do quite a lot through the web interface and Grzegorz has taught me a lot of what can be done through the web interface. If someone wants to contribute a workshop or something, they'll probs need to clone etc. but the web interface could take you a long way
- DDP: we do have the web interface guide for adding a new tutorial, but we could expand to editing stuff too
- MW: I will say, I've stuck away from explaining github workflows because they just change so quickly! I would honestly just link to the github docs for this because they at least stay updated
- DDP: agreed, and we can add some text around it to make it a bit friendlier and tell people what the general flow is and to reach out to us if they need help
- Docs PRs
- PS: there's a lot of PRs in docs that have like one approval or two approvals, and I don't know who's in charge of merging, and is Melissa's approval enough and who owns this and what's the go
- JNI: well, I think you should become more comfortable with pushing the button. Ideally you'd have a core dev approval and they would merge, but I know that there's been issues with that in the past. We should have a docs specific PR party, because we really need that
- PS: wanna touch on this actually - stuff when merged goes into dev but lots of docs aren't version specific. Is there any way we can split it into only some docs being tied to versions and the others just being static? Like blending modes for example
- JNI: well, blending modes are version specific...
- PS: well, the doc explaining the mode is in the docs, but the clarification that it blends with canvas aren't going to be in until the version updates. Are people looking at the dev docs?
- MW: yeah I think there's a couple of ways to approach. We've talked about having version independent docs e.g. home page and NAPs. The other is that this is exactly the way that every other library does it which is that you have dev docs, stable docs etc. and releases move stuff from docs to stable. However, most other libraries also have a mechanism for backporting PRs for stuff that needs to be fixed in previous versions of the docs.
- JNI: I have never seen that mechanism so I'm curious to see how that's set up, maybe we can pair?
- MW: there's even a bot, and I'm pretty sure Matthias wrote it!
- JNI: yeah we should pair, absolutely sounds like what we need.
- Juan: home page update take 2
- JNI: woo [home page PR](https://github.com/napari/docs/pull/102#pullrequestreview-1279049325) is actually up. I kept it v minimal, and I've left some comments on the PR. One thing is the code snippet is massive, we should maybe update theme. It has cards leading out to some pages which we can update at will. Would be nice to have cards be colourful or have some images but can do in a followup PR.
- PS: I love the cards. I'm not convinced that code makes that image, but I think there's something wrong with that page that it's just code so it takes me a while to realize that's what made the image (which I'm not convinced the code does)
- JNI: yeah well, you do have to click on some buttons to generate that view
- DDP: well if you have to click on buttons it's not generating that image
- DM: I would move the code snippet down and have the screenshot/webm on top. Also put getting started above examples
- JNI: yeah I kinda wondered if the examples gallery could be where people. goto see what napari can do and become convinced to install/get started. maybe a carousel would fix that
- MW: when you said webm I imagined you typing the code into a console and then napari showing up with that content
- JNI: hmm maybe but I don't want the terminal to be the first thing people see. We'd like to capture the people who are already python people when they come to the home page, and not give them the idea that this is an application and *not* a python library
- PS: I do want to say that the console is absolutely amazing, and the in viewer console is the best thing. I don't go into ipython and then launch a viewer, I launch a viewer and then go into the console so for me python is a thing, but napari is the primary thing. For other people, python is the primary thing, and napari is the secondary thing. And then there's another thing entirely which is the GUI only workflow. To me, the console is the drug, that's the first hit
- JNI: yeah the breadth of users is a huge pain point really, because it's hard to highlight all of these different things in one place
- PS: can we use the tabbed view? I've seen that places
- MW: I'm going to bring this up again but I think it would be so cool to have a side by side view of doing stuff on the GUI and doing stuff on the script, I just think that would be killer, that's what we really want. But I don't now how to display that properly on the page. I don't think tabs would work because that'll just show you one thing at a time
- JNI: yeah then we have the debate about which tab is the default. But I think that's ok, I think it's better to have that than completely omit one of the user groups. We can have a tab for python users and non python users. If people come and see there's a tab for non python users then that's more reassuring than seeing nothing at all.
- MW: yeah I think that would be very reassuring, is seeing both ways to do things. Ideally it would be side by side but I just don't know how well to display it.
- DDP: I think it's going to be impossible to have ALL three user groups prioritised on the home page, above the fold, at equal level, etc. We need to make a choice on what the first example is, though obviously immediately afterwards we want to highlight examples for all use cases. At the last core dev meeting I think folks were mostly in agreement that at the moment, we want to draw as many "python people" in as possible, because we need contributors, and they are more likely to come from experienced python users. So I think that should be the top example, immediately followed, of course, by an example for non-python users.
- MW: I'm going to explore what options there are for displaying side by side content with the sphinx theme as well
- Everybody liked that.

## 2023-01-11

- survey on website?
- as survey closes soon it's likely not useful at this stage
- also docs are versioned so only dev page would be updated
- might want to move to unversioned home page — Melissa ~~will open~~ has opened [issue about it](https://github.com/napari/docs/issues/86)
- Juan will write home page today
- Juan has started working on it :thumbsup:
- Euro friendly meeting time?
- Alternate every other meeting
- OR: do all-inclusive meeting evenings in Europe, early morning in Aus
- Juan will message with proposal - 4 hours before this meeting on same day, switches after daylight savings
- Tandem PRs for updating gallery TOC are ready for review/merge:
- https://github.com/napari/docs/pull/85
- https://github.com/napari/napari/pull/5458
- Small broken link PR ready to go too:
- https://github.com/napari/napari/pull/5465
- Link checking is next on Melissa's list
- we had lychee at some stage but we couldn't figure out how to filter the files it checked properly
- Melissa suggests a cron job running the plain sphinx link checker which she's used
- She's fixed most links locally so this would be a matter of maintenance
- PR for link fix: https://github.com/napari/docs/pull/59
- Bot for docs artifact comment
- previous bot not very useful because it was posting on everything
- Melissa found an implementation with just one sticky comment
- that worked fine, but github have changed their artifact API so you can't access them outside of the github actions UI
- there's some more complex ways of accessing that but haven't found the best solution
- napari hub preview page handles it via [an action](https://github.com/chanzuckerberg/napari-hub-preview-action) and an [app](https://github.com/apps/napari-hub)
- Is there any chance that we can use pydata-sphinx-theme directly rather than maintaining and updating the fork
- Melissa has been cherry picking from pydata-sphinx-theme when new features come up but this is not really sustainable
- Melissa can come up with a list of projects that do something similar and how they do it and make a plan for us
- Additionally should track what changes we've had on our end that we'd like to keep
- Peter [has requested](https://github.com/napari/docs/issues/66) a "Getting more help" page to make help info more discoverable
- Draga is on board - should expose better
- We need to implement the card layout for the tutorials index page so it doesn't look empty
- Melissa will open issue to remind us
- Juan will make a FOSStodon account/profile/thing? for napari imaging
- Onboarding docs are still needed and will soon be developed
- Peter has [opened a document](https://hackmd.io/2iq_CmjHR8mK0UL7e4bYaw) with common pain points/requests for new devs
- Everyone should add their own!

## 2022-11-30

- [Docs issue: Making things easy to find](https://github.com/napari/docs/issues/42)
- Melissa has suggested using cards on the landing pages to highlight the content in different sub sections
- We all loved that
- Also a great use for tags, which we should look at expanding beyond the gallery page
- Workshop template
- ready to go
- Melissa and Draga will sync on moving it to napari org
- Docs work prioritisation
- Going through [spreadsheet](https://docs.google.com/spreadsheets/d/1TUuPow75NJ70lrRbYi1-Sxn0MF5YJRHWyGGGl6QEEZs/edit#gid=0) and deciding what is done, still a priority, or not yet a priority
- Home page - clearly needs to be a priority, but is kind of stuck at the moment. It's great that we have split it roughly into sub-tasks. Draga will sync with Juan and core devs to free this up for work, or get someone to commit to working on it
- Architecture documentation - where to start? Starting with a tour of the codebase would be great. Should probably be a doc and a video. Dannielle shared [this tool](https://githubnext.com/projects/repo-visualization) for visualization that we could use to provide an overview without risking going out of date
- Tags - now they are usable, but we want to start looking at the vocabulary and axes we'd like to organize content with.

## 2022-10-13

- Melissa + Juan: 2-repo docs tomorrow! :tada:
- Draga: contributing guide needs to be updated immediately after
- Lucy: what will happen to open PRs?
- We will merge the nearly-ready ones and then we will port or ask contributor to port manually.
- Melissa: can't get napari to work on binder + Jupyter desktop. Branch work going on here: https://github.com/melissawm/napari-workshop-template/tree/binder
- Previous binder configs aren't working
- Potentially get help on Zulip#general and/or Jupyter Discourse

## 2022-09-28
- Melissa & Chi Li showed us the [napari-workshop-template](https://github.com/melissawm/napari-workshop-template) based on Alister & Kevin's different workshops. It's got instructions for setting up workshop materials & a static GitHub pages website from a repo, as well as citation information.
- Nadalyn has been working on a condensed version of the plugin testing workshop, and will sync with Draga & Chi Li to review & finalize
- 2-repo solution is almost ready and working in Melissa's branch, aside from some credential issues. Juan & Melissa will sync later this week or next week to open the corresponding PR to `napari/napari`, but we won't merge until after release
- Melissa has raised a PR (#5148) for fixing the persistent docs build comment, and following the merge it'll just post one sticky comment and then continually update it on future builds.
- Tutorials are hard to find, it looks like we have no tutorials - we should add a sentence that points to the sidebar for the different tutorial categories.
- would be nice longer term to have some kind of 'annotated-table-of-contents' directive where we can collate introductory sentences from subpages into the index page of that category
- Would be great if we could update docs independently of release so that we can keep older versions up to date. We'll look into this once we've moved to the two repo solution.
- We all need to have a look & review the proposed skeleton map for architecture docs: https://github.com/napari/napari/issues/5098

## 2022-09-14
- Nadalyn is joining us as a tech writer (just started yesterday) - welcome!
- She will first focus on the testing workshop Talley & Draga and turning the content into docs
- Will sync with Draga as needed to get context/details
- Would be great to finally tackle architecture documentation
- We know that the goal is to provide onboarding documentation for new developers so that they can quickly get up to speed and make contributions
- We're lacking all of this documentation, and Nadalyn is happy to help us tackle this
- We'll need to set up some meetings with core devs & subject matter experts to get some brain dumps and knowledge sharing, but this can come later
- First we'll open an issue linking back to [1426](https://github.com/napari/napari/issues/1426) with the goal of agreeing upon:
- a skeleton list/map of documents we'd like to write
- a list of subject matter experts who can provide the context & knowledge necessary to write these docs
- Lucy will open issue to start this discussion
- Documenting viewer actions e.g. what is a transform, what does the grid view do
- ways to interact with the viewer
- context, description & examples for different view modes, layers & layer controls
- Nadalyn can get started on this & testing workshop while we discuss skeleton for arch docs
- We need to update the docs contributor's guide to fully describe the "standard" contribution workflow of editable install + pull request, while still mentioning support for the "upload via web interface" workflow
- Draga has put this on her list

## 2022-08-31

- Melissa: fixed tags (multiple Makefiles issue)
- Melissa & Juan: will pair on two-repo solution soon;
- Chi-Li: audit of documentation missing in [viewer docs](https://docs.google.com/spreadsheets/d/1LIdX_WQfjlzeA-fdJhQxwSIWAs-YkY_H1JMjPvkx5DM/edit#gid=1103279169)
- Juan: inherit pydata sphinx theme instead of forking: https://github.com/napari/napari-sphinx-theme/issues/113
- Alister's PR: https://github.com/napari/napari/pull/4988
- Workshop repositories:
- Encourage people to use Zenodo
- Cite workshops from napari.org, including github, zenodo, and license
- Encourage use of CC0(+BY) license: https://dancohen.org/2013/11/26/cc0-by/ (As opposed to CC-BY.)
- Instructions for serving jupyter notebooks as github.io pages
- Maybe provide a template jupyter book repo?
- Check how carpentries do it (and whether they have any regrets)

## 2022-08-17

- [name=Melissa] A few options for [PR # on release notes should be links #4753](https://github.com/napari/napari/issues/4753):
- [Draft PR with sphinx-issues](https://github.com/napari/napari/pull/4920)
- [Built-in sphinx](https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html)
- [sphinx-github-role](https://github.com/astrojuanlu/sphinx-github-role/)
- [How pip does it](https://github.com/pypa/pip/blob/e2c9c40edeb65b9d26c13a12dbe5642dc2e00fd0/docs/html/conf.py#L77-L78)
- Do we want to leave a tracking issue or PR so that new contributors can help with this?
- [name=Melissa] [PR: Fix version switcher](https://github.com/napari/napari.github.io/pull/360)
- [name=Melissa] [PR: Fix docs dependencies](https://github.com/napari/napari/pull/4915)
- [name=Lucy] Docs on python models and events - would be great to get feedback [PR #4929](https://github.com/napari/napari/pull/4929)
- [name=Justin] Plugin docs revamp

## 2022-07-20

- [Follow up for versioned docs](https://github.com/napari/napari.github.io/pull/352)
- Will add version selector to all previous versions as well as dev.

## 2022-07-06

- https://github.com/napari/napari/pull/4635, https://github.com/napari/napari.github.io/pull/350
- #4635 should be merged first, and napari/napari.github.io#350 after that. Melissa will rebase and let folks know when that's ready to merge

- [name=Chi-Li] viewer action audit will be performed

- [name=Juan] home page PR [#4275](https://github.com/napari/napari/pull/4275)

## 2022-06-22

### Agenda

- [name=Chi-Li] Centralised repo for archiving workshops, so that workshops are not all scattered in different users' repos, which may get deleted etc.
- [name=Juan] Home page text has been updated based on discussions [#4275](https://github.com/napari/napari/pull/4275), but looking to make a movie of a cool dataset
- [name=Justin] Potential cool datasets: [Starfish](https://github.com/spacetx/starfish/blob/master/starfish/data.py), [Doug Shepherd's](https://shepherdlaboratory.org/) 3D lightsheet FISH data, Adam Tyson's brainreg mouse brains + regions + spot detections
- [name=Chi-Li] Cool multispectral 3D dataset; will ask for permissions
- [name=Jun / Lucy L.] Shared out how might we measure working group effectiveness and collected feedback

- [name=Melissa] Git LFS
- Juan to ping Talley. Let's make it happen.
- [Current setup on Melissa's fork (PoC)]( https://github.com/napari/napari/issues/4306#issuecomment-1132128004)
- [name=Chi-Li] synced w/ Lucy Liu re: content
- [name=Chi-Li] viewer action docs (what do buttons do)
- first, get scoping of what we have. address common buttons first, then layer-specific actions
- [name=Melissa] Versioned API docs (with version switcher)
- [PR 1](https://github.com/napari/napari/pull/4635)
- [PR 2](https://github.com/napari/napari.github.io/pull/350)
- [name=Tom] Bravo Cohort share out

### Next meeting's action items

- Juan: sphinx theme priorities
- Juan: look up saved Zulip answers and image.sc answers that could go in architecture docs
- Follow up on LFS
- [ ] Draga to open PR for "add doc git-free" with new suggestion for images (post 2repo solution)
- Follow up on home page
- Follow up on sphinx theme
- Pick six high priority content items

------

At the end of the meeting:
- Copy the contents of this document to a new file in https://github.com/napari/meeting-notes/new/main/2022/working-groups/documentation
- Clear out the Agenda from last meeting