Slate API Docs Generator Reviews

Cppcheck Reviews

Slate API Docs Generator mentions (13)

• How do i document my api ?

  Https://github.com/slatedocs/slate this ! Big company use it ( stripe etc ). Source: over 1 year ago

• [ARTICLE] Stripe Releases Their Documentation Framework

  The second most common question being "What framework does Stripe use to build their documentation?" and the answer has unfortunately always been "They use a custom setup they built themselves and isn't available." － so then Slate gets brought up as a suitable replacement. Source: about 2 years ago

• Twelve Amazing Free Hugo Documentation Themes

  DocuAPI is a multilingual API documentation theme for Hugo created and maintained by Bjørn Erik Pedersen, the lead maintainer and co-creator of Hugo itself. It’s built on top of the Slate API docs generator, which itself was inspired by Stripe’s and PayPal’s API docs. The JavaScript section of DocuAPI has been rewritten from Jquery to AlpineJS.​​​​​​. - Source: dev.to / about 2 years ago

• Best way to document Express API

  I've used Slate to document APIs which similarly will produce a local website. You can host that privately or there's built in support to push to github pages if you're hosting it in a github repo. The documentation itself is all written in markdown and managed separate from your API code. Source: about 2 years ago

• Building API Docs

  We used to use Slate - https://github.com/slatedocs/slate for our APIs in my previous job. That was pretty neat. - Source: Hacker News / over 2 years ago

Cppcheck mentions (10)

• Configuring Cppcheck, Cpplint, and JSON Lint

  I dedicated Sunday morning to going over the documentation of the linters we use in the project. The goal was to understand all options and use them in the best way for our project. Seeing their manuals side by side was nice because even very similar things are solved differently. Cppcheck is the most configurable and best documented; JSON Lint lies at the other end. - Source: dev.to / 3 months ago

• Enforcing Memory Safety?

  Using infer, someone else exploited null-dereference checks to introduce simple affine types in C++. Cppcheck also checks for null-dereferences. Unfortunately, that approach means that borrow-counting references have a larger sizeof than non-borrow counting references, so optimizing the count away potentially changes the semantics of a program which introduces a whole new way of writing subtly wrong code. Source: 12 months ago

• Static Code analysis

  For my own projects, I used cppcheck. You can check out that tool to get a feel. Depending on what industry your in, you might need to follow a standard like Misra. Source: about 1 year ago

• How do you not shoot yourself in the foot ?

  Https://cppcheck.sourceforge.io/ (there are many other static analysis tools, I just haven't used them or didn't care for them). Source: about 1 year ago

• Linting tool for prohibiting the use of specific std types

  Sounds like something that could simply be communicated with the team that writes the tests. Unless you have dozens of such classes. In that case, you could just use e.g. Cppcheck and add a rule (regular expression) that searches for usages of the forbidden classes. Source: over 1 year ago