Skip to content

Commit f4512e4

Browse files
committed
fix(docs): add required sections to FAQ and fix devcontainer link
Add empty usage and examples sections to satisfy expected-html-sections linter. Fix devcontainer-setup link to point to correct file path.
1 parent c270df1 commit f4512e4

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

docs/contributing/FAQ.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,20 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
381381
- [Git Cheatsheet][git-guide]
382382
- [Other make commands][make-commands]
383383
384+
<!-- FIXME: the following two empty sections are merely to satisfy the linter for `expected-html-sections` which cannot, atm, be turned off -->
385+
386+
<section class="usage">
387+
388+
</section>
389+
390+
<!-- /.usage -->
391+
392+
<section class="examples">
393+
394+
</section>
395+
396+
<!-- /.examples -->
397+
384398
<section class="links">
385399
386400
[git]: http://git-scm.com/
@@ -401,7 +415,7 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
401415
402416
[manual-setup]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md#step-0-github
403417
404-
[devcontainer-setup]: https://github.com/stdlib-js/stdlib/blob/87cbd67623892f90ddeea94e1d4e01eeada417b5/docs/devcontainer_setup.md
418+
[devcontainer-setup]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/setting_up_a_devcontainer.md
405419
406420
[devcontainer-issue]: https://github.com/stdlib-js/stdlib/issues/4934
407421

0 commit comments

Comments
 (0)