Editorial review checklist

Posts on the Vilvik blog go through a quick review before they publish. The bar is the same as what you would expect from a small product blog: clearly written, on topic, the screenshots work, the links resolve. This page covers what the reviewer is looking for, so you can self-check before you click Submit for review.

Topic¶

Posts that work well on the blog cover one of:

• A walkthrough of a specific problem you solved on Vilvik.
• A tutorial that uses Vilvik features, PyGAD, or the SDK.
• Notes on a less-obvious technique you found, with results.

Posts that are off topic for the blog include sales copy for a product, unrelated essays, and anything that is essentially a comment thread on another post.

Writing¶

• The first paragraph tells the reader what the post is about and what they will know after reading it.
• Headings break the post into sections that a reader can skim. Use H2 for the section level; H3 is fine for sub-points.
• One idea per paragraph. Long paragraphs are hard to read on mobile.
• Code blocks have a language tag so they syntax-highlight. python, bash, json, and yaml all work.

Images¶

• Cover image is included. It becomes the social card too, so make sure it reads at 1200 by 630 pixels.
• Every inline image has alt text describing what is in the image. The editor's image-insert dialog asks for this.
• Screenshots crop tightly to the part you are pointing at. Full-window screenshots of an entire IDE rarely add anything.

Links¶

• Internal links go through {% verbatim %}{% url '...' %}{% endverbatim %} so they stay correct if a page moves. The Markdown editor accepts the URL template tag inside link targets.
• External links use plain URLs.

The slug¶

Slugs are auto-generated from the title and editable until you submit. After the post publishes the slug is locked so inbound links keep working. If you need to rename a published post, ask an editor and they can do it with a permanent redirect from the old URL.