Skip to content

docs: Enhance case study 01 notebook and update documentation#97

Merged
AdemBoukhris457 merged 3 commits intomainfrom
feature/case_study_01_enhancements
Nov 26, 2025
Merged

docs: Enhance case study 01 notebook and update documentation#97
AdemBoukhris457 merged 3 commits intomainfrom
feature/case_study_01_enhancements

Conversation

@AdemBoukhris457
Copy link
Owner

Description

This MR enhances the case study 01 financial report analysis notebook with improved display features and updates the documentation to include it in the notebooks table.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Changes Made

Notebook Enhancements (notebooks/case_study_01_financial_report_analysis.ipynb)

  • ✅ Add PDF pages display at the beginning (after Step 1)
  • ✅ Display table descriptions from TOC alongside extracted dataframes
  • ✅ Add Step 8 to display full markdown output from StructuredPDFParser
  • ✅ Remove duplicate and empty cells
  • ✅ Fix cell ordering (PDF display after Step 1, markdown display after Step 7)

Documentation Updates

  • ✅ Add case study 01 to README.md Interactive Notebooks table
  • ✅ Add case study 01 to English documentation (docs/en/index.md)
  • ✅ Add case study 01 to Chinese documentation (docs/zh/index.md)

Testing

  • Notebook cells execute correctly
  • All markdown files render properly
  • No linting errors
  • Table formatting is correct in all three locations

Checklist

  • Tests pass (N/A for documentation/notebook changes)
  • Code formatted (N/A for markdown files)
  • Documentation updated
  • No breaking changes

…on, and add markdown output

- Add PDF pages display at the beginning after loading the document
- Display table descriptions from TOC alongside extracted dataframes
- Add Step 8 to display full markdown output from StructuredPDFParser
- Remove duplicate and empty cells
- Fix cell ordering (PDF display after Step 1, markdown display after Step 7)
- Add case_study_01_financial_report_analysis to the notebooks table
- Include Colab badge and description for financial report analysis case study
- Add case_study_01_financial_report_analysis to English docs (docs/en/index.md)
- Add case_study_01_financial_report_analysis to Chinese docs (docs/zh/index.md)
- Include Colab badges and descriptions in both languages
- Add a pdf file for testing
@AdemBoukhris457 AdemBoukhris457 self-assigned this Nov 26, 2025
@AdemBoukhris457 AdemBoukhris457 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 26, 2025
@AdemBoukhris457 AdemBoukhris457 merged commit 7c49971 into main Nov 26, 2025
1 check passed
@AdemBoukhris457 AdemBoukhris457 deleted the feature/case_study_01_enhancements branch November 26, 2025 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant