Skip to content

wiki: fix wiki lint errors#1801

Merged
chappjc merged 1 commit intodecred:masterfrom
ukane-philemon:fixwikilint
Aug 22, 2022
Merged

wiki: fix wiki lint errors#1801
chappjc merged 1 commit intodecred:masterfrom
ukane-philemon:fixwikilint

Conversation

@ukane-philemon
Copy link
Copy Markdown
Contributor

This is a follow-up PR addressing the discussion here and typos. The wiki is formatted based on the rules add by #1796.

Comment thread docs/wiki/Client-Installation-and-Configuration.md Outdated
Comment thread docs/wiki/Client-Installation-and-Configuration.md Outdated
Comment thread docs/wiki/Home.md Outdated
Comment thread docs/wiki/Home.md Outdated
Comment on lines +21 to +24
```text
$ git remote add wiki https://github.com/your-username/dcrdex.wiki.git
$ git push wiki -d master
$ git subtree push --prefix docs/wiki wiki master
Copy link
Copy Markdown
Member

@chappjc chappjc Aug 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's actually a markdownlint rule we've ignored that says not to use $ without showing output. While I don't think we need to show output to be permitted to use $ (hence rule ignored), I also don't think we need the $ in every case unless it is really needed to underscore that the commands are typed and it's obvious and explicit here. Or if the $ breaks the syntax highlighting, not sure if it does. Also this can be sh instead of text - these are shell commands even if there's nothing special about them.

Comment thread docs/wiki/Home.md Outdated
The JavaScript strings involved editing [client/webserver/site/src/js/locales.js](https://github.com/decred/dcrdex/blob/master/client/webserver/site/src/js/locales.js) with a new `export const zhCN` object, with strings corresponding to the English text in the `enUS` object at the top of the same file. Finally, the new object is listed in the `const localesMap` at the end of the file.

When testing, remember to rebuild the site assets bundle with `npm ci && npm run build` in the **client/webserver/site** folder. No newline at end of file
When testing, remember to rebuild the site assets bundle with `npm ci && npm run build` in the **client/webserver/site** folder.
Copy link
Copy Markdown
Member

@chappjc chappjc Aug 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for re-adding newlines at the end of the files. This is important for all text files, not just markdown. https://unix.stackexchange.com/questions/18743/whats-the-point-in-adding-a-new-line-to-the-end-of-a-file
decred/dcrd#2941

In general, we should do it for all docs and code decred/dcrd#2941

Comment thread docs/wiki/Testnet-Testing.md Outdated
Comment thread docs/wiki/Testnet-Testing.md Outdated
Comment thread docs/wiki/Testnet-Testing.md Outdated
Comment thread docs/wiki/Testnet-Testing.md Outdated
@chappjc chappjc merged commit 5e78c84 into decred:master Aug 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants