Skip to content

Commit

Permalink
Warn about tutorial titles (#1185)
Browse files Browse the repository at this point in the history
Today's meeting reminded me of this gotcha. Adding it to the readme to
save someone a headache in the future.
  • Loading branch information
frankharkins authored Apr 16, 2024
1 parent 090781a commit 124e143
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ tutorials](https://github.com/Qiskit/documentation/actions/workflows/deploy-tuto
workflow. This will push the notebooks on the main branch to the environment
you select.

> [!NOTE]
> One potential gotcha is that the learning platform ignores the top-level
> heading of the notebook. These headings are only included in the notebook for
> writers' convenience. If you want to change the title of a notebook, find the
> page on https://learning-api.quantum.ibm.com/admin and change its title
> there. Make sure to update the title in the notebook too.
## Adding new tutorials

Each tutorial has its own folder in `tutorials/`. Within that folder is the content notebook
Expand Down

0 comments on commit 124e143

Please sign in to comment.