Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweak link to troubleshooting guide and issue template #165

Merged
merged 1 commit into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ assignees: ''
---

**Check troubleshooting**
Please first check [TROUBLESHOOTING.md](https://github.com/almindor/mipidsi/blob/master/docs/TROUBLESHOOTING.md) to ensure your issue is not solved there already.
Before submitting a new issue, please check the [troubleshooting guide](https://github.com/almindor/mipidsi/blob/master/docs/TROUBLESHOOTING.md) to make sure it hasn't already been addressed there.

**Describe the bug**
A clear and concise description of what the bug is.
Expand All @@ -22,8 +22,13 @@ A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.

**MCU and Display model**
Please provide specific MCU and display model used
**Used hardware and software**
Please provide details about the hardware and software you are using:
- `mipidsi` version: e.g. latest `master` or `0.9.1`
- MCU: e.g. ESP32S3
- HAL: e.g. esp_hal 0.23.1
- Display Controller IC: e.g. ILI9341
- Type of connection: e.g. SPI

**Additional context**
Add any other context about the problem here.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,11 @@ Variants that require different screen sizes and window addressing offsets are n
- ST7789
- ST7796

## Migration

See [MIGRATION.md](../docs/MIGRATION.md) document.


## Troubleshooting

See [TROUBLESHOOTING.md](https://github.com/almindor/mipidsi/blob/master/docs/TROUBLESHOOTING.md) if you're having issues with blank screen or incorrect colors showing up.
Refer to the [troubleshooting guide](https://github.com/almindor/mipidsi/blob/master/docs/TROUBLESHOOTING.md) if you experience problems like a blank screen or incorrect colors.

### Example
## Example

```rust
// create a DisplayInterface from SPI and DC pin, with no manual CS control
Expand All @@ -66,6 +61,9 @@ let mut display = Builder::new(ILI9486Rgb666, di)
// clear the display to black
display.clear(Rgb666::BLACK)?;
```
## Migration

See [MIGRATION.md](../docs/MIGRATION.md) document.

## Minimum Supported Rust Version (MSRV)

Expand Down
4 changes: 3 additions & 1 deletion docs/TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Display troubleshooting
# Troubleshooting guide

This guide lists common issues that can cause a blank or corrupted display.

## Display stays black/blank

Expand Down
6 changes: 4 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@
//! * ST7796
//!
//! ## Troubleshooting
//! See [TROUBLESHOOTING.md](https://github.com/almindor/mipidsi/blob/master/docs/TROUBLESHOOTING.md) if you're having
//! issues with blank screen or incorrect colors showing up.
//!
//! Refer to the [troubleshooting guide](https://github.com/almindor/mipidsi/blob/master/docs/TROUBLESHOOTING.md)
//! if you experience problems like a blank screen or incorrect colors.
//!
//! ## Examples
//!
//! **For the ili9486 display, using the SPI interface with no chip select:**
//! ```
//! use mipidsi::interface::SpiInterface; // Provides the builder for DisplayInterface
Expand Down
Loading