Match JSON and modules in order to read data stored in modules

[igorpecovnik]

Description

We need to show command / module architecture and perhaps other data, which is only stored in module. It will add more information:

• where key is present and we have a match

Implementation Details

Add new field to JSON structure which serves to match those two - for the purpose of making proper documentation.

Testing Procedure

• Manual run

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have ensured that my changes do not introduce new warnings or errors
• No new external dependencies are included
• Changes have been tested and verified
• I have included necessary metadata in the code, including associative arrays

[coderabbitai]

Caution

Review failed

The pull request is closed.

## Walkthrough

A new function, `extract_module_options_from_sh_files(directory)`, was introduced in `tools/config-markdown.py` to parse `.sh` files within a specified directory, extracting key-value pairs that match the pattern `["module,key"]="value"`. This function builds a nested dictionary mapping module names to their respective options and loads these options at runtime from the `lib/armbian-config` directory, storing them in a global `module_options` dictionary. In the `create_markdown_user` function, the handling of sub-item metadata was revised: the previously included author metadata line is now commented out, and if a sub-item has a `module` attribute, the script appends maintainer, status, architecture, and documentation link information to the markdown output using a new formatting style with double underscores and markdown line breaks. Additionally, the JSON configuration for software installation menu entries was updated to include a `"module"` key for multiple software items, associating each entry with its corresponding module.

## Possibly related PRs

- armbian/configng#584: Adds the same `extract_module_options_from_sh_files(directory)` function and modifies `create_markdown_user` to incorporate module metadata from `.sh` files based on a new `"module"` key in JSON entries, making it directly related.

## Suggested labels

`ready to merge`

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 786b161 and 39acdb7.

📒 Files selected for processing (2)

• tools/config-markdown.py (2 hunks)
• tools/json/config.software.json (18 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.