Add structure to documentation and copy Heads related pages from trmm.net#49
Conversation
| QR code in your phone by running: | ||
|
|
||
| ``` | ||
| ```shell |
There was a problem hiding this comment.
Seeing all of those outdated shell scripts calls makes me extremely unconfortable.
Do not know what to do with that and source of most of the confusion.
Search in page ".sh"
There was a problem hiding this comment.
Part of the markdownlint is to assign a language to code blocks. These are not shell scripts as much as they are the shell command in the documentation.
There was a problem hiding this comment.
My point here was links to old not even existing shell scripts should be removed
There was a problem hiding this comment.
Oh I see. I haven't started updating the install documents, so these will be removed or corrected.
|
@Thrilleratplay Excellent!!!! Saw that porting guide was also totally off and not covering board pointing to coreboot (bot needs to be unique per board) and board pointing to linux config (can be shared) Please tag my name when you need review. I agree with all proposed changes here. |
|
@tlaurion Thanks for the encouragement but I still have quite a bit of work do for everything to blend together. I have been finding a lot of information is various Heads issue discussions. Any questions I have, I'll ask the slack channel. I will tag you as well as asking the channel again to review when ready. |
…ferent steps/pages
|
@Thrilleratplay The only think I see missing is linked to small misunderstanding about WP bits that should be linked for advenaced users to experiment from, not state it as working. Heads-wiki refers to:
I'm really happy with the status of this PR. Would love others to read through and have linked a lot of Heads users to this PR and your staging website, but no comment on this PR came out of it. Could let it sit until Friday and then merge? @osresearch: you ok with those mods? |
|
@Thrilleratplay : Sorry to be so validating.... |
@tlaurion Many of the bad links are due to how Jekyll's generates them. Many of the edit links are pointing to https://github.com/osresearch/heads-wiki/edit/master/ for pages that do not exist but will exist after this has been merged. Another catch 22 are pages that would link correctly when on |
|
@Thrilleratplay : please run url validation! |
|
@tlaurion I did and need to fix a few things. I should have another PR to correct these within the hour. |
Changes can be viewed here: https://thrilleratplay.github.io/heads-wiki/
At this point, I am mainly looking at feed back on the current changes and if the next steps are where these changes should be going.
Currently done:
Next steps:
I feel like the different Heads related copied from trmm.net could use some clean up. Links are dying and dated 2015, 2016; including newer examples over the years to show this is still a continuous problem. Additionally, links to the wayback machine should be kept to an absolute minimum. Overall, they should be reworded to have a sense of cohesion within the wiki instead of feeling like they were copied from another site. @osresearch, as these are your words, would you be ok with this? Obviously they could also link to the original pages.