Skip to content

Commit 6b36dcb

Browse files
committed
feat: return adding author instructions to contribution guide
1 parent d2aa5d3 commit 6b36dcb

File tree

1 file changed

+19
-2
lines changed
  • content/pages/contribution-guide/writing-content

1 file changed

+19
-2
lines changed

content/pages/contribution-guide/writing-content/index.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,30 @@ After you finish writing, revisit your summary to see if it needs any adjustment
6464

6565
#### Add youself as an author
6666

67-
The default Espressif author is used:
67+
To add yourself as an author, [create an article](#create-and-view-an-article) and follow the instructions in the article's `index.md` YAML header.
68+
69+
If the article already exists and you want to edit the authors, here are the same instructions:
70+
71+
- Create your author entry
72+
- Create your page at `content/authors/<author-name>/_index.md`
73+
- Add your personal data at `data/authors/<author-name>.json`
74+
- Add the following to your article's YAML header
75+
```yaml
76+
authors:
77+
- "<author-name>" # List your name(s)
78+
```
79+
80+
In some cases, it might be better to add the default Espressif author:
6881
6982
- If the author prefers to stay anonymous
7083
- For posts generated by scripts, such as automatic compilations, release notes, and so on
7184
- For articles generated with AI
7285
73-
In other cases, add yourself as an author. For this, follow the instructions in the article's YAML header.
86+
To add the default author, include this in your article's YAML header:
87+
```yaml
88+
showAuthor: true
89+
```
90+
7491
7592
## Write the content
7693

0 commit comments

Comments
 (0)