feat: create gif files and store them in a simple markdown file

[manishraj-003]

Fixes #2875.

Changes

I've created a markdown file(.md) which stores all the gif files used in experiment demonstration.

Screenshots / Recordings

N/A

Checklist:

• No hard coding: I have used values from constants.dart or localization files instead of hard-coded values.
• No end of file edits: No modifications done at end of resource files.
• Code reformatting: I have formatted the code using dart format or the IDE formatter.
• Code analysis: My code passes checks run in flutter analyze and tests run in flutter test.

Summary by Sourcery

Documentation:

• Add a markdown document listing all GIF files used for barometer, channel parameters, and light distance experiment demonstrations.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a new documentation markdown file that catalogs GIF assets used in experiment demonstration screens, linking directly to their image paths.

Flow diagram for gif documentation markdown linking to assets

flowchart TD
    DocsMarkdown[gif_files_md]
    AssetsFolder[assets_images]

    DocsMarkdown --> BarometerExperiment1_gif
    DocsMarkdown --> BarometerExperiment2_gif
    DocsMarkdown --> BarometerExperiment3_gif
    DocsMarkdown --> Channel_parameters_gif
    DocsMarkdown --> LightDistance1_gif
    DocsMarkdown --> LightDistance2_gif
    DocsMarkdown --> LightDistance3_gif

    AssetsFolder --> BarometerExperiment1_gif
    AssetsFolder --> BarometerExperiment2_gif
    AssetsFolder --> BarometerExperiment3_gif
    AssetsFolder --> Channel_parameters_gif
    AssetsFolder --> LightDistance1_gif
    AssetsFolder --> LightDistance2_gif
    AssetsFolder --> LightDistance3_gif

Loading

File-Level Changes

Change	Details	Files
Introduce a markdown document listing GIFs used in experiment demonstration guides.	Create docs/gif_files.md with a top-level description heading Add sections for BarometerExperiment, Channel parameters, and LightDistance Experiment Embed corresponding GIFs for each experiment via relative paths to assets/images	docs/gif_files.md

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#2875	Create GIF files for the experiment demonstrations and place them under assets/images.	❌	The PR only adds a docs/gif_files.md file that references GIFs under assets/images; it does not add or modify any GIF assets themselves.
#2875	Reference the created GIF files in the experiment guide screens within the app.	❌	The PR does not change any experiment guide screen code or UI; it only documents GIF paths in a markdown file.

Possibly linked issues

• Create Gif files for experiment demonstration. #2875: PR provides a markdown index referencing the experiment GIFs stored under assets/images, matching the issue’s requirement.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• Consider using consistent heading levels (e.g., start with ## for the main title instead of ###) so the markdown structure is logically nested and renders as expected in different viewers.
• Replace the generic alt text placeholders with descriptive alt text for each GIF to improve accessibility and make the file more self-explanatory.
• Standardize section and file naming (e.g., BarometerExperiment vs LightDistance Experiment) so experiment names follow a consistent spacing/capitalization convention.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Consider using consistent heading levels (e.g., start with `##` for the main title instead of `###`) so the markdown structure is logically nested and renders as expected in different viewers.
- Replace the generic `alt text` placeholders with descriptive alt text for each GIF to improve accessibility and make the file more self-explanatory.
- Standardize section and file naming (e.g., `BarometerExperiment` vs `LightDistance Experiment`) so experiment names follow a consistent spacing/capitalization convention.

## Individual Comments

### Comment 1
<location> `docs/gif_files.md:4-13` </location>
<code_context>
+### gif files used in the experiment demonstration guide screen
+
+## BarometerExperiment
+![alt text](../assets/images/barometerExperiment1.gif)
+![alt text](../assets/images/barometerExperiment2.gif)
+![alt text](../assets/images/barometerExperiment3.gif)
+
+## Channel parameters
+![alt text](../assets/images/channel_parameters.gif)
+
+## LightDistance Experiment
+![alt text](../assets/images/lightDistance1.gif)
+![alt text](../assets/images/lightDistance2.gif)
+![alt text](../assets/images/lightDistance3.gif)
+
</code_context>

<issue_to_address>
**suggestion:** Use descriptive alt text for images instead of the generic placeholder "alt text".

The current `![alt text](...)` placeholders don’t provide useful information to screen readers or users if the GIFs fail to load. Replace them with short, specific descriptions of each GIF’s content (e.g., "Barometer experiment – step 1" or "Channel parameters screen").
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion: Use descriptive alt text for images instead of the generic placeholder "alt text".

The current ![alt text](...) placeholders don’t provide useful information to screen readers or users if the GIFs fail to load. Replace them with short, specific descriptions of each GIF’s content (e.g., "Barometer experiment – step 1" or "Channel parameters screen").