Skip to content

Commit e23b746

Browse files
committed
Fix README
1 parent 3aebc25 commit e23b746

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ The **excerpt separator** `<!-- more -->` must be included, typically after the
7979

8080
**Images** should be placed in the same folder as the markdown file, and linked using markdown syntax, e.g. `![Alt text](my_image.png)`. By default, images are scaled to min(original size, text width), but this can look too large for high-res square images. In this case, use the classes `.img-tiny`, `.img-small`, `.img-medium` or `.img-large` to limit the maximum size, e.g. `![Alt text](my_image.png){:.img-small}`.
8181

82+
To **publish** when you're happy with your post, push it to a branch on [draft-graphcore-research.github.io](https://github.com/graphcore-research/draft-graphcore-research.github.io) for review. When it's merged into `main`, push it to [graphcore-research.github.io](https://github.com/graphcore-research/graphcore-research.github.io), e.g. if the remotes are `public` and `origin`: `git push public origin/main:main`.
83+
8284
### POTM
8385

8486
Papers-of-the-month are special, consisting of a **root** page at `pages/posts/potm/YYYY/MM/potm.md`, and multiple **child** pages at `pages/posts/potm/YYYY/MM/paper-slug/paper-slug.md`. They should have specific frontmatter:
@@ -125,11 +127,11 @@ You can write a post as a notebook. It will not be executed by the build process
125127
- The excerpt separator `<!-- more -->` must be included in a markdown cell near the top.
126128
- All markdown features should work as they do for posts (e.g. relative links to images).
127129
- By default **code cell content is not rendered**, only the outputs. There are two ways to render an individual cell's code: (a) use the "Add Tag" feature to add the cell tag "show_input" or (b) write `# SHOW_INPUT` on the first line (which will be stripped for display).
128-
- If using exotic output formats, you may need to update the hook in [hooks/notebook_to_markdown.py](hooks/notebook_to_markdown.py).
130+
- If using exotic output formats, you may need to update the hook in [hooks/render_notebook.py](hooks/render_notebook.py).
129131

130132
### Our Papers
131133

132-
To add a paper to the "Our Papers" page, add it to [pages/publications.data.yml](pages/publications.data.yml), as described in the file.
134+
To add a paper to the "Our Papers" page, add it to [pages/.publications.yml](pages/.publications.yml), as described in the file.
133135

134136
### Hiring Banner
135137

@@ -152,7 +154,7 @@ File/folder structure:
152154
├── posts/potm/ # Papers of the month, with special handling ([hooks/merge_potm.py](hooks/merge_potm.py)) to merge children into root
153155
├── .authors.yml # Author information, required for every author alias
154156
├── .redirects.json # Generate redirects to keep old links working (by [hooks/generate_redirects.py](hooks/generate_redirects.py))
155-
├── publications.md.j2 # "Our Papers" page template, rendered by [hooks/render_page_templates.py](hooks/render_page_templates.py)
157+
├── publications.md.j2 # "Our Papers" page template, rendered by [hooks/render_page_template.py](hooks/render_page_template.py)
156158
├── publications.data.yml # "Our Papers" data
157159
├── *.md # Other standalone pages
158160
├── site/ # Generated static site (after `mkdocs build`)

0 commit comments

Comments
 (0)