Armbian Build Framework Script [DOC-1] #5894
Open
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
## Pull Request Description ### Documentation-Centric: Armbian Build Framework Wrapper Script #### Overview This pull request introduces a wrapper script designed with a strong emphasis on generating comprehensive and user-friendly documentation for the Armbian Build Framework. The implementation aims to provide various output formats, including man pages, markdown, and potentially JSON, to cater to different aspects of the larger system. #### Features Implemented - Added a basic wrapper script to provide a simplified interface. - Improved help messages for better documentation. - Initial support for multiple system languages (English, German, Spanish). #### Features to be Implemented - Implemented functionality to generate man pages for the wrapper script. - Integrated support for generating markdown documentation. - Designed with flexibility to potentially output JSON documentation. #### Continuinf Testing - Rigorous testing of the documentation generation process to ensure accuracy and completeness. - Fine-tuning of the output formats for optimal readability. #### Additional Notes - The primary focus of this implementation is to enhance the accessibility and comprehensibility of the Armbian Build Framework through robust documentation.
Tearran
changed the title
added json
fix error
implemented Translation switch in all function
|
You are doing something strange with localization) |
drooped example functions to fix language switching. json output seems working
@adeepn It seems like you found something interesting with localization! I appreciate the link to the BashFAQ, and running LANGUAGE=es_ES ./armbian-build.sh was quite insightful. I want to mention that the language selection in my script was primarily a placeholder for addressing locales. The main focus was on formatting the English output into JSON, key pairs, and dialog boxes. A loop for gettext could potentially be set up to improve localization. It's a work in progress, and I'm open to any suggestions or improvements. Thanks for your input! |
removed language switch. fixed loop iteration of descriptions
added tui output
Quick Video showing the outputsExample of the html outputhttps://codepen.io/Tearran/pen/ZEwKaXe Quick use{
wget https://raw.githubusercontent.com/Tearran/build/DOC-1/armbian-build ;
bash ./armbian-build -h ;
} |
Tearran
changed the title
igorpecovnik
added
Needs review
Tearran
changed the title
| Feature | desc | example | src_reference | status | | :-----: | :---: | :---: | :-----: | :---------: | quick formatting to array and a markdown table
github-actions
bot
added
the
size/medium
|
Will output features.md and featuesr.sh Hidden_options
|
|
Quick conversions of https://github.com/armbian/build/pull/6389/files This is a great array. as Tried to make PR update, maybe idea is enough to talk. |
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.
Pull Request Description
Documentation-Focused: Armbian Build Framework
Overview
This pull request introduces a user-friendly script that acts as a bridge to interact with the Armbian Build Framework. Its main goal is to enhance accessibility and facilitate communication for users who may not be familiar with the underlying script.
Key Features
- Supports multiple system languages (English, German, Spanish).todoFuture Enhancements
Testing
Extensive testing will be conducted to ensure accurate and complete documentation generation, as well as fine-tuning of output formats for optimal readability.
Additional Information
The primary focus of this implementation is to enhance the accessibility and comprehensibility of the Armbian Build Framework through robust documentation.