Skip to content

Add Highcharts and map examples for testing and demonstrations #1196

Description

@aidanbruneel

Summary

Create a maintained, public-facing collection of example Highcharts and map cases that IMAGE developers can use for:

  • Manual developer testing
  • Investigating supported and unsupported cases
  • Demonstrations and presentations
  • Identifying useful future test fixtures

Existing and similar examples are currently spread across older issues, comments, and individual lists. They should have a clear canonical location in the repository.

Proposed documentation location

Add component-specific example sectoins in IMAGE-server README.md files:

  • handlers/high-charts/README.md or a more suitable README.md file.
  • preprocessors/openstreetmap/README.md or a more suitable README.md file.

These sections should remain useful to external contributors and project partners rather than being written only for the internal McGill team.

Information to include

For each example, include as applicable:

  • Example name
  • Source or webpage
  • Chart, map, or scenario type
  • What the example is intended to test (if applicable)
  • Date the example was last verified

For map examples, include coordinates, location information, or other reproducible inputs when a webpage link alone is insufficient.

Link maintenance

These sections should state that external examples are maintained on a best-effort basis. Third-party webpages may change or disappear, so a broken example does not necessarily indicate a regression in IMAGE.

The examples should be reviewed when related Highcharts or map functionality is substantially changed.

Existing material

If applicable, please review and consolidate any relevant examples from:

Acceptance criteria

Out of scope

This issue does not require any programming.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions