NH-88760: add markdown lint and link #142
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| !lambda/.aws-sam/** | ||
| !.github/pull_request_template.md | ||
| !.github/ISSUE_TEMPLATE/bug-or-feature-request.md | ||
| continue-on-error: true |
There was a problem hiding this comment.
Seeing this warning:
Warning: Unexpected input(s) 'continue-on-error', valid inputs are ['config', 'fix', 'globs', 'separator']
Run DavidAnson/markdownlint-cli2-action@v[1](https://github.com/solarwinds/apm-ruby/actions/runs/10395387675/job/28787280482?pr=142#step:3:1)
yardoc_frontpage.md
Outdated
| @@ -1,24 +1,24 @@ | |||
| # Welcome to the SolarWindsAPM Ruby Gem | |||
|
|
|||
| # Welcome to the SolarWindsAPM Ruby Gem | |||
There was a problem hiding this comment.
Curious, how/where is this yardoc page used?
There was a problem hiding this comment.
Yardoc page is used in https://www.rubydoc.info/gems/solarwinds_apm, but I think it's broken. Will fix it.
There was a problem hiding this comment.
Although, the file yardoc_frontpage.md is used in .yardopts (point yardoc_frontpage.md as default readme), but since appoptics, rubydoc.info doesn't use the yardoc_frontpage.md as default readme.
There was a problem hiding this comment.
If you're finding that it's not used anymore feel free to delete :)
There was a problem hiding this comment.
Do we need some sort of welcome page for rubydoc.info? or the current README is sufficient?
There was a problem hiding this comment.
This is our current https://rubydoc.info/github/solarwinds/apm-ruby page you're referring to, yes? IMHO it is enough so we don't need the yardoc_frontpage content.
Description
Test (if applicable)