Comments (1)
Hi @Strooom. Thanks for your interest in the Arduino Lint rule documentation.
The reason this link is broken is because this library.md
file is programmatically generated from the Arduino Lint code.
This content is intended to be read on the documentation website here:
https://arduino.github.io/arduino-lint/dev/rules/
I considered the idea of storing the generated documentation in the repository alongside the code when I started working with the system in the Arduino CLI repository, but I was unsure if it would be worth the effort because the documentation will need to be updated on every code change that affects it. Since that time, we added a documentation versioning system and never had any reports until now of people hitting those broken links, even though Arduino CLI is a very popular project. That made me feel like it was not so much needed.
But perhaps there is a way to more effectively communicate that the files under docs
are only the source code of the website content. MkDocs expects that all the Markdown files under docs
are meant to be part of the website, so adding a README.md
to the folder to contain the explanation would cause the website validation to fail. But a README.txt
could be used instead to avoid that problem.
from arduino-lint.
Related Issues (20)
- Add "zero-length board ID" rule HOT 4
- Please add check for invalid examples e.g. containing no ino file HOT 3
- Question: Why are library names limited to 16 characters? (low prio) HOT 2
- Add maximum file system size rule for libraries
- Add the ability to mute some rules HOT 1
- Strict check on libraries should check for header guards or #pragma once HOT 2
- Consider raising LP048 to error instead of warning HOT 2
- Feature Request: Add ability to exclude certain sub-folders from checks
- Feature request: Support macOS arm64 HOT 5
- Update link LP018 HOT 1
- arduino-lint can't load url from library.properties (http status 503) HOT 3
- New error raised with 1.2.1 while it should not
- My `examples` directory is getting ignored HOT 1
- Change of LP010: Increase character limit for naming Arduino libraries
- Publish Arduino project JSON schemas to "JSON Schema Store"
- Allow test sketches to be outside examples folder HOT 1
- Documentation and linter setup mismatch HOT 1
- Specify link to Github, BitBucket or GitLab as requirement for `url` field HOT 1
- Broken symlinks in libraries results in linter panic HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from arduino-lint.