Skip to content

Commit

Permalink
Fix markdown on documents
Browse files Browse the repository at this point in the history
  • Loading branch information
MinhNguyen-nvm committed Dec 7, 2024
1 parent dbcee5a commit 0d2d160
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,12 @@ For more detail on reports, see [Report Detail][report_doc]
App Sizer functions as a mapping tool to generate the report. It takes APK, AAR, and JAR files as inputs.

1. **Input parsing**:
- The tool parses the APK down to file and class levels. It calculates the contribution of each component to the total app download size.
- Similarly, App Sizer parses AAR and JAR files.
- The tool parses the APK down to file and class levels. It calculates the contribution of each component to the total app download size.
- Similarly, App Sizer parses AAR and JAR files.

2. **Mapping and Report Generation**:
- The tool then maps the APK components to their corresponding elements in the AAR and JAR files.
- Based on this analysis and other metadata, App Sizer generates comprehensive reports detailing size contributions.
- The tool then maps the APK components to their corresponding elements in the AAR and JAR files.
- Based on this analysis and other metadata, App Sizer generates comprehensive reports detailing size contributions.

## Limitations

Expand Down
11 changes: 6 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ For command line configuration options, see [Commandline Configuration][cli_doc]

App Sizer currently supports three types of reports:

* InfluxDB database (1.x) - It is suitable for CI tracking and enabling the creation of customized dashboards (with visualization tools like Grafana). We provide an InfluxDB and Grafana setup; see our [Docker Setup Guide][grafana-docker].
* InfluxDB database (1.x) - It is suitable for CI tracking and enabling the creation of customized dashboards (with visualization tools like Grafana). We provide an InfluxDB and Grafana setup; see our [Docker Setup Guide][grafana_docker_doc].
* Markdown table for convenient local analysis.
* JSON data for compatibility with other platforms.

Expand All @@ -94,11 +94,12 @@ For more detail on reports, see [Report Detail][report_doc]
App Sizer functions as a mapping tool to generate the report. It takes APK, AAR, and JAR files as inputs.

1. **Input parsing**:
- The tool parses the APK down to file and class levels. It calculates the contribution of each component to the total app download size.
- Similarly, App Sizer parses AAR and JAR files.
- The tool parses the APK down to file and class levels. It calculates the contribution of each component to the total app download size.
- Similarly, App Sizer parses AAR and JAR files.

2. **Mapping and Report Generation**:
- The tool then maps the APK components to their corresponding elements in the AAR and JAR files.
- Based on this analysis and other metadata, App Sizer generates comprehensive reports detailing size contributions.
- The tool then maps the APK components to their corresponding elements in the AAR and JAR files.
- Based on this analysis and other metadata, App Sizer generates comprehensive reports detailing size contributions.

## Limitations

Expand Down

0 comments on commit 0d2d160

Please sign in to comment.