-
-
Notifications
You must be signed in to change notification settings - Fork 0
README
Sajmir Doko edited this page Oct 31, 2025
·
3 revisions
This directory contains the complete documentation for the TallPress - Laravel Blog Package, structured for GitHub Wiki.
| 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 |
# 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- Go to https://github.com/sajdoko/tallpress/wiki
- Click "New Page" or edit existing pages
- Copy content from each
.mdfile - Save with the corresponding page name
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)
Update wiki documentation when you:
- Add new features
- Change configuration options
- Modify API endpoints
- Add Artisan commands
- Change installation process
- Update requirements
- Edit files in
wiki/directory - Test links and formatting (use Markdown preview)
- Commit to main repository:
git add wiki/
git commit -m "docs: update wiki documentation"
git push origin main- Publish to wiki (see methods above)
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)# Page Title (H1 - only one per page)
## Main Section (H2)
### Subsection (H3)
#### Detail (H4)```bash
# Shell commands
php artisan tallpress:install
```
```php
// PHP code
$post = Post::create([...]);
```
```json
{
"key": "value"
}
```**Important:** This is important information.
**Note:** This is a note.
**Tip:** This is a helpful tip.| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Data 1 | Data 2 | Data 3 |- Unordered item
- Another item
- Nested item
1. Ordered item
2. Another item
3. Third itemWhen adding new documentation:
- Create
.mdfile inwiki/directory - Add to
_Sidebar.mdnavigation - Link from
Home.mdtable 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
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
Home (Landing)
├── Getting Started
│ ├── Installation
│ ├── Configuration
│ └── Quick Start
├── User Guides
│ ├── Usage Guide
│ ├── Admin Interface
│ ├── API Documentation
│ └── Styling & Assets
└── Development
└── Contributing
- Keep it simple - Clear, concise explanations
- Show examples - Code examples for every concept
- Use visuals - Screenshots for UI features
- Stay current - Update with package changes
- Link liberally - Connect related topics
- Think user-first - What would users need to know?
- Questions about docs - GitHub Discussions
- Documentation bugs - GitHub Issues
- Suggestions - Open an issue or discussion
Last Updated: October 29, 2025
Getting Started
User Guides
Development