Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Recommended hardware #25

Closed
wants to merge 63 commits into from
Closed

Recommended hardware #25

wants to merge 63 commits into from

Conversation

mghill
Copy link
Contributor

@mghill mghill commented Nov 26, 2020

Now that most of the process is down from going over the key-concepts PR, I'll start marshaling other content in PRs as it gets to a similar level. If it's preferable to get a version of the site up with just basic content, these can simply be held until it's ready.

@mghill mghill self-assigned this Nov 26, 2020
@mghill mghill linked an issue Nov 26, 2020 that may be closed by this pull request
@mghill
Copy link
Contributor Author

mghill commented Nov 26, 2020

Odd to note that spelling check didn't pull up the readme.md "issues" (not part of this PR) as it did in #22

@kimburgess
Copy link
Contributor

That will be due to this having branches from master rather than key-concepts (which has the updated config currently). Once that merges in, proofreading will be a little more consistent.

@mghill
Copy link
Contributor Author

mghill commented Nov 26, 2020

Further on the spelling issues - I don't think it's necessarily worth adding each and every model name & number to the linter, but I also can't think of a (regex etc) way to filter out model numbers/non-word names without skipping legitimate typos (especially as some of them are intentionally misspelled words. Ugh).
Also not crash hot on the idea of leaving it so that these errors will be picked up by the checks in all future PRs. Thoughts?

  • We could omit specific docs from future checks
  • Could just have a ticker of standard/known numbers of "errors"
  • Could create some sort of very extensive allow/skip list in the linter

Not great options

@mghill
Copy link
Contributor Author

mghill commented Dec 7, 2020

Updated in line with both #26 and #27 to use <i> around models/brands (plus adding common ones to the linter) and to refactor the tabs feature as Details.

@vercel
Copy link

vercel bot commented Dec 10, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/placeos/docs/d0ohnu8mp
✅ Preview: Failed

[Deployment for 8592a33 failed]

kimburgess and others added 8 commits December 10, 2020 12:17
* flag write-good suggestions as warnings only

Previous config (default or error) would cause check status to fail.
This should instead be neutral, with the suggestion as an annotation.

* mark Rousseau suggestions as neutral

* remove duplication between rousseau and write-good

* add filter rule for idomatic terms

* ignore local package-lock.json files

* simplify acronyms regex
@kimburgess
Copy link
Contributor

kimburgess commented Dec 11, 2020

@mghill the history of this branch and associated change set is a bit wild. Might be worth a prune (or placing the intended doc state onto a fresh branch from master) before looking at merging.

@mghill mghill mentioned this pull request Dec 13, 2020
@mghill
Copy link
Contributor Author

mghill commented Dec 13, 2020

Yep, absolute mess. Creating #35 and closing this PR & branch

@mghill mghill closed this Dec 13, 2020
@mghill mghill deleted the recommended-hardware branch December 13, 2020 23:59
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrated Recommended Hardware Page
2 participants