Detailed Docs & Onboarding improvements
This commit is contained in:
ajaysi
283
docs/tutorials/getting_started.rst
Normal file
283
docs/tutorials/getting_started.rst
Normal file
@@ -0,0 +1,283 @@
|
||||
Getting Started with AI-Writer
|
||||
==========================
|
||||
|
||||
This tutorial will guide you through the process of setting up and using AI-Writer for the first time. By the end, you'll be able to generate your first piece of AI-powered content.
|
||||
|
||||
Prerequisites
|
||||
------------
|
||||
|
||||
Before you begin, make sure you have the following:
|
||||
|
||||
1. **Python Environment**:
|
||||
|
||||
* Python 3.10 or higher installed
|
||||
* pip package manager
|
||||
* Virtual environment tool (optional but recommended)
|
||||
|
||||
2. **System Dependencies**:
|
||||
|
||||
* Windows: Microsoft Visual C++ Build Tools
|
||||
* Linux: build-essential and python3-dev packages
|
||||
* Rust compiler (for certain dependencies)
|
||||
|
||||
3. **API Keys** (optional for some features):
|
||||
|
||||
* OpenAI API key
|
||||
* Google API key (for Gemini)
|
||||
* Tavily API key (for web research)
|
||||
* Stability AI key (for image generation)
|
||||
|
||||
Installation
|
||||
-----------
|
||||
|
||||
Follow these steps to install AI-Writer:
|
||||
|
||||
1. **Clone the Repository**:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://github.com/AJaySi/AI-Writer.git
|
||||
cd AI-Writer
|
||||
|
||||
2. **Create a Virtual Environment** (optional but recommended):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# Using venv
|
||||
python -m venv venv
|
||||
|
||||
# Activate on Windows
|
||||
venv\\Scripts\\activate
|
||||
|
||||
# Activate on Linux/Mac
|
||||
source venv/bin/activate
|
||||
|
||||
3. **Install Dependencies**:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install -r requirements.txt
|
||||
|
||||
4. **Check System Dependencies**:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
python install_dependencies.py
|
||||
|
||||
5. **Launch the Application**:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
streamlit run alwrity.py
|
||||
|
||||
The application should now be running at http://localhost:8501.
|
||||
|
||||
Configuration
|
||||
------------
|
||||
|
||||
Before using AI-Writer, you'll need to configure it with your preferences and API keys:
|
||||
|
||||
1. **Open the Sidebar**:
|
||||
|
||||
* Click on the ">" icon in the top-left corner of the application
|
||||
|
||||
2. **Configure API Keys**:
|
||||
|
||||
* Enter your API keys for the services you plan to use
|
||||
* API keys are stored securely in your local environment
|
||||
|
||||
3. **Set Language and Region**:
|
||||
|
||||
* Choose your preferred language and region for content generation
|
||||
* This affects the research results and content style
|
||||
|
||||
4. **Configure UI Settings**:
|
||||
|
||||
* Adjust the UI theme and layout according to your preferences
|
||||
|
||||
Your First Content Generation
|
||||
----------------------------
|
||||
|
||||
Let's create your first blog post using AI-Writer:
|
||||
|
||||
1. **Select the Blog Writer**:
|
||||
|
||||
* From the main menu, select "AI Blog Writer"
|
||||
|
||||
2. **Enter Keywords**:
|
||||
|
||||
* Type in 2-3 keywords related to your topic
|
||||
* Example: "artificial intelligence content creation"
|
||||
|
||||
3. **Configure Options**:
|
||||
|
||||
* Select blog length (Short, Medium, Long)
|
||||
* Choose whether to include web research (recommended)
|
||||
* Select your target audience
|
||||
|
||||
4. **Generate Content**:
|
||||
|
||||
* Click the "Generate Blog" button
|
||||
* Wait for the AI to research and create your content
|
||||
|
||||
5. **Review and Edit**:
|
||||
|
||||
* Review the generated content
|
||||
* Make any necessary edits or adjustments
|
||||
* Use the regenerate option for specific sections if needed
|
||||
|
||||
6. **Export Your Content**:
|
||||
|
||||
* Copy the content to your clipboard
|
||||
* Export as Markdown or HTML
|
||||
* Save to your local database
|
||||
|
||||
Example: Generating a Blog Post
|
||||
------------------------------
|
||||
|
||||
Here's a step-by-step example of generating a blog post about "sustainable gardening":
|
||||
|
||||
1. Select "AI Blog Writer" from the main menu
|
||||
|
||||
2. Enter the following information:
|
||||
|
||||
* Keywords: "sustainable gardening techniques"
|
||||
* Blog Length: Medium
|
||||
* Include Web Research: Yes
|
||||
* Target Audience: Home Gardeners
|
||||
|
||||
3. Click "Generate Blog" and wait for the process to complete
|
||||
|
||||
4. Review the generated blog, which should include:
|
||||
|
||||
* An engaging introduction
|
||||
* Several sections on sustainable gardening techniques
|
||||
* Practical tips and advice
|
||||
* A conclusion with key takeaways
|
||||
|
||||
5. Edit any sections that need improvement
|
||||
|
||||
6. Export your blog post for publishing
|
||||
|
||||
Using Web Research
|
||||
----------------
|
||||
|
||||
Web research enhances your content with factual information:
|
||||
|
||||
1. **Enable Web Research**:
|
||||
|
||||
* Make sure the "Include Web Research" option is checked
|
||||
|
||||
2. **Select Research Sources**:
|
||||
|
||||
* Choose from available research providers:
|
||||
* Google Search
|
||||
* Tavily AI
|
||||
* Exa Search
|
||||
* Custom URLs
|
||||
|
||||
3. **Adjust Research Depth**:
|
||||
|
||||
* Select how deep the research should go
|
||||
* More depth means more comprehensive but slower results
|
||||
|
||||
4. **Review Research Results**:
|
||||
|
||||
* See what sources were used in your content
|
||||
* Check the research summary for key points
|
||||
|
||||
5. **Regenerate with Different Research**:
|
||||
|
||||
* If needed, you can regenerate with different research parameters
|
||||
|
||||
Customizing Content Style
|
||||
-----------------------
|
||||
|
||||
AI-Writer allows you to customize the style of your content:
|
||||
|
||||
1. **Tone Selection**:
|
||||
|
||||
* Choose from tones like Professional, Casual, Informative, etc.
|
||||
* The tone affects the writing style and vocabulary
|
||||
|
||||
2. **Content Structure**:
|
||||
|
||||
* Select different content structures:
|
||||
* Problem-Solution
|
||||
* How-To Guide
|
||||
* Listicle
|
||||
* Comparison
|
||||
* Story-based
|
||||
|
||||
3. **Writing Style**:
|
||||
|
||||
* Adjust parameters like:
|
||||
* Sentence length
|
||||
* Paragraph density
|
||||
* Technical level
|
||||
* Use of examples
|
||||
|
||||
4. **SEO Optimization**:
|
||||
|
||||
* Enable SEO optimization for better search visibility
|
||||
* Adjust keyword density and placement
|
||||
|
||||
Troubleshooting
|
||||
--------------
|
||||
|
||||
If you encounter issues, try these solutions:
|
||||
|
||||
1. **Application Won't Start**:
|
||||
|
||||
* Check Python version (must be 3.10+)
|
||||
* Verify all dependencies are installed
|
||||
* Check for error messages in the terminal
|
||||
|
||||
2. **API Connection Issues**:
|
||||
|
||||
* Verify API keys are entered correctly
|
||||
* Check internet connection
|
||||
* Ensure API services are available
|
||||
|
||||
3. **Content Generation Fails**:
|
||||
|
||||
* Try with simpler keywords
|
||||
* Disable web research temporarily
|
||||
* Check API usage limits
|
||||
|
||||
4. **Slow Performance**:
|
||||
|
||||
* Reduce research depth
|
||||
* Generate shorter content
|
||||
* Close other resource-intensive applications
|
||||
|
||||
Next Steps
|
||||
---------
|
||||
|
||||
Now that you've created your first piece of content, here are some next steps:
|
||||
|
||||
1. **Explore Other Writers**:
|
||||
|
||||
* Try the Social Media Writer
|
||||
* Experiment with the Email Writer
|
||||
* Create a YouTube script
|
||||
|
||||
2. **Use SEO Tools**:
|
||||
|
||||
* Analyze your content for SEO
|
||||
* Generate meta descriptions
|
||||
* Create structured data
|
||||
|
||||
3. **Plan Your Content**:
|
||||
|
||||
* Use the Content Calendar feature
|
||||
* Generate content ideas for the month
|
||||
* Create a content strategy
|
||||
|
||||
4. **Learn Advanced Features**:
|
||||
|
||||
* Check out the advanced tutorials
|
||||
* Explore API integration
|
||||
* Try the AI agents feature
|
||||
|
||||
For more detailed information, refer to the [User Guide](../user_guide/index.rst) and [API Documentation](../api/index.rst).
|
||||
Reference in New Issue
Block a user