docs: tidy up the readme, add toc. #1141
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
hugomrdias
suggested changes
Sep 3, 2020
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
hugomrdias
previously approved these changes
Sep 3, 2020
License: MIT Signed-off-by: Oli Evans <oli@tableflip.io>
yiannisbot
reviewed
Sep 3, 2020
| - `path`: Repository's URL without protocol. | ||
| - `source`: Folder from the repository referenced in the `path` to be mounted into the local Hugo filesystem. | ||
| - `target`: Folder where `source` will be mounted locally, this should follow this structure `content/modules/<target value>`. | ||
| The markdown documents should all be well formed, with a single h1, and headings should increment by a single level. |
There was a problem hiding this comment.
Suggested change
| The markdown documents should all be well formed, with a single h1, and headings should increment by a single level. | |
| The markdown documents should all be well formed, with **only a single h1**, and headings should increment by a single level. |
Do we want to highlight that there should be only one h1 heading?
|
|
||
| Error: failed to download modules: go command failed ... | ||
|
|
||
| **Solution** - run `npm run clean` - the cache dir hugo uses can get corrupted, and this resets it. See [#1048](https://github.com/filecoin-project/specs/issues/1048) | ||
|
|
There was a problem hiding this comment.
I would put the front matter properties, common problems and how to link to external modules above math mode and diagrams, as less people will want to add math and diagrams than actually edit the front matter.
| title: Important thing | ||
| weight: 1 | ||
| dashboardState: wip | ||
| dashboardAudit: missing | ||
| --- |
There was a problem hiding this comment.
We should mention how the frontmatter links to dashboard entries and that when adding a new subsection in a new file (as opposed to a subsection within the _index file) there's a new dashboard entry created. Therefore, adding new files should be done only when necessary, i.e., when a subsubsection is important and should appear in the dashboard.
hugomrdias
added a commit
that referenced
this pull request
Sep 7, 2020
* master: (27 commits) fix(content): filecoin VM interface update (#1056) fix(content): chainsync section update (#1123) fix(content): libraries section update (#1115) fix: show hugo errors on build docs: tidy up the readme, add toc. (#1141) fix: reword stacked drg missing link text" fix: fix broken refs and change warns to errors (#1139) fix: import meter css (#1140) feat: build toc and dashboard in hugo (#1122) feat: show wip and reliable in progress bar (#1137) content: fix typo plus remove definition of weight (#1138) fix: css for label style and dashboard link (#1136) feat: add symbol embeds and listing (#1126) v1.0.1 feat(tooling): release scripts v1.0.0 chore: update readme and package.json fix: update dns link fix: fix broken links fix(content): FIL VM System Actors Update (#1061) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is best reviewed by looking at the entire rendered file at https://github.com/filecoin-project/specs/blob/68b9416b2d628639eabec6c5e5778345c9fb0a9f/README.md
License: MIT
Signed-off-by: Oli Evans oli@tableflip.io