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

Doc improvements #577

Merged
merged 2 commits into from
Apr 14, 2024
Merged

Doc improvements #577

merged 2 commits into from
Apr 14, 2024

Conversation

EDDYMENS
Copy link
Contributor

@EDDYMENS EDDYMENS commented Apr 14, 2024

Finally done with my project and had time to properly go over the docs

Not done yet but here is what I have so far

Changes:

Minor

  • Grammar fix and rewording

Major

I am not sure (Just a suggestion)

  • Dropped the use of $ in the bash snippets (Copying to clipboard copies the symbol) Line 27

@Kikobeats
Copy link
Member

oh wow, thanks for this, really appreciated.

Can you feedback me about browserless? Did you find it useful for your project? What can be improved (besides doc 😬) ?

@EDDYMENS
Copy link
Contributor Author

EDDYMENS commented Apr 14, 2024

@Kikobeats sure personally I really like the idea of the CLI tool.
I am a technical writer and from time to time I need to do things like check if the links on the page are broken etc.

The idea of a CLI is very very helpful in this case since I don't have to do everything in code (which changes depending on the doc site) for example, I have no interest in testing nav links on the site but only links from the rendered document

With the CLI I get to use a more declarative approach with commands which is quicker than rewriting code.

If the CLI had browser actions baked in eg: >browserless goto example.com & click [div#menu] & screenshot ` that would be another level but I don't think that's the goal of this project.

I also love the screenshot feature with the browser stencil, I am not much of a graphic designer, but for me to be able to easily place my screenshot in a browser stencil using code, I am all for it.

@Kikobeats
Copy link
Member

Thanks for the feedback!

I have another project for detecting broken links and it uses browserless by default, check
https://github.com/urlint/urlint 🙂

BTW I think this is kind of what you describe urlint/urlint#57

@EDDYMENS
Copy link
Contributor Author

Thanks for the feedback!

I have another project for detecting broken links and it uses browserless by default, check https://github.com/urlint/urlint 🙂

BTW I think this is kind of what you describe urlint/urlint#57

This is nice! so I just checked it out and set prerender to true because the site I tested it on is an SPA, but it seems to miss the broken link on the site.

@Kikobeats Kikobeats merged commit 9213d76 into microlinkhq:master Apr 14, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants