Overview
<Provide a short summary of the article: what it covers and why it exists.>
Prerequisites
- <Access / permissions required (e.g., WordPress Editor role, WeDocs group access)>
- <Required tools, accounts, or versions (e.g., WordPress 6.x, WeDocs plugin installed)>
- <Any files, templates, or screenshots to prepare>
Steps
1. Log in to WordPress
- Open
bnitech.io/adminconsoleand sign in with your credentials.
2. Open WeDocs / Documentation Group
- In the left admin menu click WeDocs → All Docs.
- Select the appropriate documentation group (e.g., Public, Private).
3. Create or Duplicate an Article
- Recommended: Duplicate the project template:
- Open the template article.
- Click the block menu (three dots) → Duplicate.
- Rename the duplicated article to the new article title.
- Alternatively, click Add New → Doc to start a blank article.
4. Edit with Gutenberg (Blocks)
- Use the + (Add block) button to insert Paragraphs, Headings, Lists, Images, and Code blocks.
- For any heading you want included in the WeDocs sidebar, set an HTML anchor (see step below).
- Use the block menu (⋮) for block-specific actions: Duplicate, Add before/after, Copy styles, Group, Lock, etc.
5. Add Anchor Tags (HTML Anchors)
To let WeDocs or an on-page table of contents link directly to a section:
- Select the heading block.
- In the block settings panel → Advanced → HTML Anchor, enter a short identifier (no spaces), e.g.
install-steps. - Or use the heading tag’s id in HTML mode:
<h2 id="install-steps">Install steps</h2>
6. Insert Screenshots & Images
- Use the Image block to upload or select from Media Library.
- Provide concise captions and mark each image with context (e.g., “Figure 1 — Admin menu”).
7. Save and Publish
- Click Save Draft while editing.
- When final, click Publish.
- Verify the article appears in the correct WeDocs group and that anchors/TOC links work.
Troubleshooting
<Common problems and fixes. Examples below: >
- Heading anchor not working: Ensure the ID has no spaces and is unique on the page.
- Images not visible: Confirm image permissions or re-upload to Media Library.
- Cannot duplicate template: Check user permissions; an Editor or Admin may be required.
Related Articles
- Template: Wiki Article Template (duplicate this for new docs)
- How to Add & Annotate Screenshots
- <Add other internal doc links or KB IDs>
Change Log
| Date | Change | Author |
|---|---|---|
| <YYYY-MM-DD> | Created article template | <Author Name> |
