Skip to content
Sajmir Doko edited this page Oct 31, 2025 · 3 revisions

Wiki Documentation

This directory contains the complete documentation for the TallPress - Laravel Blog Package, structured for GitHub Wiki.

📁 Wiki Pages

File Wiki Page Description
Home.md Home Main landing page with overview
Installation.md Installation Installation guide and requirements
Configuration.md Configuration Configuration options and settings
Usage-Guide.md Usage Guide How to use the package in your app
Admin-Interface.md Admin Interface Complete admin panel guide
API-Documentation.md API Documentation RESTful API reference
Styling-and-Assets.md Styling & Assets Customizing styles and assets
Contributing.md Contributing Development workflow and guidelines
_Sidebar.md Sidebar Navigation sidebar for wiki

🚀 Publishing to GitHub Wiki

Method 1: Clone Wiki Repository (Recommended)

# Clone the wiki repository
git clone https://github.com/sajdoko/tallpress.wiki.git

# Copy all wiki files
cp wiki/*.md tallpress.wiki/

# Navigate to wiki directory
cd tallpress.wiki

# Commit and push
git add .
git commit -m "Update documentation"
git push origin master

Method 2: Manual Upload

  1. Go to https://github.com/sajdoko/tallpress/wiki
  2. Click "New Page" or edit existing pages
  3. Copy content from each .md file
  4. Save with the corresponding page name

Page Name Mapping

When creating wiki pages, use these exact names:

  • Home.md → Create page named "Home"
  • Installation.md → Create page named "Installation"
  • Configuration.md → Create page named "Configuration"
  • Usage-Guide.md → Create page named "Usage-Guide"
  • Admin-Interface.md → Create page named "Admin-Interface"
  • API-Documentation.md → Create page named "API-Documentation"
  • Styling-and-Assets.md → Create page named "Styling-and-Assets"
  • Contributing.md → Create page named "Contributing"
  • _Sidebar.md → Create page named "_Sidebar" (for navigation)

📝 Maintaining Documentation

When to Update

Update wiki documentation when you:

  • Add new features
  • Change configuration options
  • Modify API endpoints
  • Add Artisan commands
  • Change installation process
  • Update requirements

Updating Workflow

  1. Edit files in wiki/ directory
  2. Test links and formatting (use Markdown preview)
  3. Commit to main repository:
git add wiki/
git commit -m "docs: update wiki documentation"
git push origin main
  1. Publish to wiki (see methods above)

Link Format

Internal wiki links:

[Installation Guide](Installation)
[API Documentation](API-Documentation)

External links:

[GitHub Repository](https://github.com/sajdoko/tallpress)
[Buy me a coffee](https://www.buymeacoffee.com/sajdoko)

Anchors (same page):

[Quick Start](#quick-start)

🎨 Formatting Guidelines

Headings

# Page Title (H1 - only one per page)
## Main Section (H2)
### Subsection (H3)
#### Detail (H4)

Code Blocks

```bash
# Shell commands
php artisan tallpress:install
```

```php
// PHP code
$post = Post::create([...]);
```

```json
{
  "key": "value"
}
```

Alerts/Notes

**Important:** This is important information.

**Note:** This is a note.

**Tip:** This is a helpful tip.

Tables

| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Data 1   | Data 2   | Data 3   |

Lists

- Unordered item
- Another item
  - Nested item

1. Ordered item
2. Another item
3. Third item

✅ Checklist for New Documentation

When adding new documentation:

  • Create .md file in wiki/ directory
  • Add to _Sidebar.md navigation
  • Link from Home.md table of contents
  • Use consistent formatting
  • Test all internal links
  • Add code examples where relevant
  • Include troubleshooting section if applicable
  • Commit to main repository
  • Publish to GitHub wiki

🔍 Reviewing Documentation

Before publishing, verify:

  • All links work correctly
  • Code examples are accurate
  • Screenshots are up to date (if any)
  • Formatting is consistent
  • No typos or grammatical errors
  • Version-specific information is noted
  • Covers all edge cases

📊 Documentation Structure

Home (Landing)
├── Getting Started
│   ├── Installation
│   ├── Configuration
│   └── Quick Start
├── User Guides
│   ├── Usage Guide
│   ├── Admin Interface
│   ├── API Documentation
│   └── Styling & Assets
└── Development
    └── Contributing

💡 Best Practices

  1. Keep it simple - Clear, concise explanations
  2. Show examples - Code examples for every concept
  3. Use visuals - Screenshots for UI features
  4. Stay current - Update with package changes
  5. Link liberally - Connect related topics
  6. Think user-first - What would users need to know?

🆘 Getting Help


Last Updated: October 29, 2025