-
-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix multiple typo's #40
Conversation
It appears that the README.md file might have been manually edited. For consistency and to ensure that documentation updates are accurately reflected, please use the Additionally, considering the importance of maintaining accurate and up-to-date documentation, it might be beneficial to implement a questionnaire for pull requests similar to the one used by Armbian Build. This would help ensure that all necessary steps are followed and documentation is updated appropriately. a proposed template for such a questionnaire has been added PULL_REQUEST_TEMPLATE.md based on armbian build PULL_REQUEST_TEMPLATE.md |
Where are the instructions to do this?... I dropped the README.md commit on a local clone, then ran armbian-configng --doc. I compared the results, and there was still a typo. I also discovered that a script from config.ng.docs.sh was expanding variables when writing to README.md and hard coding the architecture of the machine where armbian-configng --doc was run. I delimited the '$' characters to get it to work. There could be confusion caused by the description "3rd party Debian based distributions" for example if run it on Linux Mint 21.3 (jammy) output would be: deb [arch=amd64 signed-by=/usr/share/keyrings/armbian.gpg] http://apt.armbian.com virginia main virginia-utils virginia-desktop Linux Mint Debian based LMDE 6 (bookworm) install would replace virginia with faye. Of course neither of these distributions exist at Armbian. But jammie and bookworm do exist. I have changed this PR to draft until you review. |
distributions script must remain unexpanded in the README.md file
Thanks for pointing this out! Separating the development and user instructions has been a bit tricky. The README is usually for devs, but it seems like the docs are leaning towards users. Do you have any suggestions on how we can split these up better?
I'm a bit confused here. Did you manage to fix said typo, or is it still there? Please let me know so I can address it appropriately.
I see you’ve caught the missing escape slash already and corrected this. Thanks for catching that and fixing it! |
All typo's that I spotted are fixed. I've marked it ready for review. |
Fixing typo's in multiple files.