fusionauth-site
vale
fusionauth-site | vale | |
---|---|---|
6 | 46 | |
43 | 4,178 | |
- | 1.0% | |
9.9 | 9.3 | |
6 days ago | 10 days ago | |
MDX | Go | |
GNU General Public License v3.0 or later | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
fusionauth-site
-
Vale.sh – A Linter for Prose
Have tried to use this a few times but it's a big lift. Like adding unit tests to an existing application, it's a good idea to start small. And vale doesn't make this super easy (at least I couldn't figure out an easy way to do this). If I could wave my wand, I'd want a way to:
* apply vale to just the doc I was working on
* have a minimal set of rules
* add to them over time
At $curjob, we have a detailed public list of rules of doc ( https://github.com/FusionAuth/fusionauth-site/blob/master/Do... ) and as our team expands, I'd love to have them be applied rigorously. vale seems like a good fit, but there's an activation energy that I haven't been able to get over yet.
I am not aware of any other cli tools similar to this, though, so totally admire the team behind it.
-
CIAM vs. IAM: What's the difference (2022)
Thanks for the comments! Will try to address them in the near future, tracking here: https://github.com/FusionAuth/fusionauth-site/issues/2170
-
Mermaid Cheat Sheet
I actually have much more experience with plantuml (we actually have a plugin which generates diagrams for our jekyll/asciidoc docs site: https://github.com/FusionAuth/fusionauth-site/blob/master/si... ), but I have recently started using mermaid for a project and like it so far.
-
Automating screenshots for the Datasette documentation using shot-scraper
I had a colleague (thanks Sanjay!) make a similar tool at a hackfest (you can see the source code here: https://github.com/FusionAuth/fusionauth-site/blob/master/sr... ).
I've modified it a bit to take a URL, but haven't yet set it up to read a config file to make a large number of screenshots easy to do.
We do outline certain fields or other areas in the doc to highlight a point. That's caused some hesitation on my part. However, it looks like I could use imagemagick to automatically put a red box or similar on an image (with a `-draw` command).
We have a ton of screenshots (600+) throughout our doco, and a way to initialize our product to a known state, so the pieces are all there.
One of these days it'll be worthwhile to do this.
- The Modern Guide to OAuth
- Preview of Microsoft Build of OpenJDK
vale
- Software Technical Writing: A Guidebook [pdf]
- Grammarly editor writing service are malfunctioning
- Vale.sh – A Linter for Prose
- Ask HN: Best tool to proof-read technical documentation?
- Val, a high-level systems programming language
-
Common Bugs in Writing
Vale is an OSS tool that you can use as a "prose linter" with many of these rules. You can also write your own rules. Together with a spellchecker its a good replacement for proprietary tools like grammarly.
- https://github.com/errata-ai/vale
-
Just Simply – Stop saying how simple things are in our docs
> Write in US English with US grammar. (Tested in British.yml.)
heh, that was funny but it turns out the file is a list of British words checked using Vale, which I just learned existed: https://github.com/errata-ai/vale#readme (MIT)
Also, another TIL is that the "e" version of gray is British https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale... I had previously erroneously assumed they were just one of those quirks of English (which, I guess is still true but it is less random than I thought)
-
Tools that enforce/promote corporate standards?
Off the top of my head, Vale and Acrolinx.
-
Over 60% of Writers Already Use AI in Their Writing Workflow
I have recently thought of feeding the suggestions from Vale (https://vale.sh/) into an LLM along with your writing. Currently I just simply ask an LLM to take what I wrote and put it into a more "active voice". I then manually edit my writing to make it more "active" if I choose -- I do not just publish LLM generated content unaltered.
Note: I did not ask an LLM for this comment.
-
What terminal apps are you using?
vale to spell check and enforce writing style on my articles
What are some alternatives?
SuperTokens Community - Open source alternative to Auth0 / Firebase Auth / AWS Cognito
proselint - A linter for prose.
prosemd-lsp - An experimental proofreading and linting language server for markdown files ✍️
lsp-grammarly - lsp-mode ❤️ grammarly
chappe - 🧑💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.
nvim-lspconfig - Quickstart configs for Nvim LSP
the-usher-server - Authorization server. The Usher looks at your ticket and tells you where you're authorized to go.
write-good - Naive linter for English prose
datasette-app - The Datasette macOS application
markdownlint - Repository for the markdownlint-mdl-action Github Action
cargo-spellcheck - Checks all your documentation for spelling and grammar mistakes with hunspell and a nlprule based checker for grammar
remark-lint - plugins to check (lint) markdown code style