Update markdown config and remove spellcheck files
Added a new .markdownlint.json configuration file to manage markdown linting rules. Removed .spellcheck.yml and .wordlist.txt as they are no longer needed. Updated several markdown files to simplify content and remove outdated references.
This commit is contained in:
xixu-me committed
1 parent
029d382eb1
commit
ba3230e13d
10 files changed
+24
-53
No files matched your search
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"default": true,
|
||||
"MD013": false,
|
||||
"MD040": false
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
matrix:
|
||||
- name: Markdown
|
||||
sources:
|
||||
- "**/*.md"
|
||||
aspell:
|
||||
lang: en
|
||||
dictionary:
|
||||
wordlists:
|
||||
- .wordlist.txt
|
||||
pipeline:
|
||||
- pyspelling.filters.markdown:
|
||||
markdown_extensions:
|
||||
- pymdownx.superfences
|
||||
- pyspelling.filters.html:
|
||||
comments: false
|
||||
ignores:
|
||||
- code
|
||||
- pre
|
||||
@@ -1,5 +0,0 @@
|
||||
Copilot
|
||||
GitHub
|
||||
DevOps
|
||||
JWT
|
||||
MongoDB
|
||||
+1
-1
@@ -268,7 +268,7 @@ Brief description of what this prompt does and why it's valuable.
|
||||
|
||||
### Contributors
|
||||
|
||||
All contributors are recognized in our README and contributor documentation. Significant contributions may be highlighted in releases and community updates.
|
||||
All contributors are recognized in our README and contributor documentation.
|
||||
|
||||
### Maintainer Responsibilities
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
A comprehensive collection of professional AI prompts across various categories, designed to enhance productivity, creativity, and technical workflows. This library provides battle-tested prompts with clear examples, usage instructions, and best practices.
|
||||
|
||||
[](https://github.com/xixu-me/prompt-library/actions/workflows/quality-assurance.yml)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](CONTRIBUTING.md)
|
||||
[](https://github.com/xixu-me/prompt-library/releases)
|
||||
|
||||
## 📈 Library Features
|
||||
|
||||
|
||||
@@ -1,13 +1,5 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
The Prompt Library follows semantic versioning. Security updates are provided for the following versions:
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 1.0.x | :white_check_mark: |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
We take security seriously. If you discover a security vulnerability in the Prompt Library, please report it responsibly:
|
||||
@@ -25,7 +17,6 @@ We take security seriously. If you discover a security vulnerability in the Prom
|
||||
|
||||
- **Acknowledgment**: We'll acknowledge receipt within 48 hours
|
||||
- **Assessment**: Initial assessment within 5 business days
|
||||
- **Resolution**: Security fixes will be prioritized and released as patch versions
|
||||
- **Disclosure**: Coordinated disclosure after fix is available
|
||||
|
||||
### Security Considerations for Prompts
|
||||
|
||||
@@ -334,9 +334,8 @@ Balance engaging plot, accessible characters, and market appeal while delivering
|
||||
|
||||
## Related Prompts
|
||||
|
||||
- [Character Designer](./character-designer.md) - For developing compelling characters
|
||||
- [World Builder](./world-builder.md) - For creating detailed fictional settings
|
||||
- [Creative Story Generator](../writing/creative-story-generator.md) - For shorter story concepts
|
||||
- [Brainstorming Session](./brainstorming-session.md) - For generating creative ideas
|
||||
|
||||
## Tags
|
||||
|
||||
|
||||
@@ -219,8 +219,6 @@ Ensure the lesson plan is age-appropriate, engaging, and aligns with educational
|
||||
## Related Prompts
|
||||
|
||||
- [Quiz Generator](quiz-generator.md) - Create assessments for this lesson
|
||||
- [Study Guide Creator](study-guide-creator.md) - Build review materials
|
||||
- [Learning Objective Writer](learning-objective-writer.md) - Refine lesson goals
|
||||
|
||||
## Tags
|
||||
|
||||
|
||||
@@ -193,8 +193,6 @@ d) British naval dominance
|
||||
## Related Prompts
|
||||
|
||||
- [Lesson Plan Generator](lesson-plan-generator.md) - Create lessons to prepare for this assessment
|
||||
- [Study Guide Creator](study-guide-creator.md) - Help students prepare effectively
|
||||
- [Learning Objective Writer](learning-objective-writer.md) - Align assessments with clear goals
|
||||
|
||||
## Tags
|
||||
|
||||
|
||||
@@ -13,29 +13,29 @@ Provide the technical topic, target audience, and documentation type needed. Inc
|
||||
```markdown
|
||||
Create technical documentation for the following:
|
||||
|
||||
**Documentation Type:**
|
||||
### Documentation Type
|
||||
[User Guide / API Documentation / Tutorial / Technical Specification / README / Other]
|
||||
|
||||
**Target Audience:**
|
||||
### Target Audience
|
||||
[Developers / End Users / System Administrators / Technical Writers / Other]
|
||||
|
||||
**Technical Subject:**
|
||||
### Technical Subject
|
||||
[Describe what needs to be documented]
|
||||
|
||||
**Requirements:**
|
||||
### Requirements
|
||||
- **Scope**: [What should be covered and what should be excluded]
|
||||
- **Format**: [Markdown / HTML / PDF / Wiki / Other]
|
||||
- **Length**: [Brief overview / Comprehensive guide / Reference manual]
|
||||
- **Technical Level**: [Beginner / Intermediate / Advanced / Mixed audience]
|
||||
|
||||
**Source Material:**
|
||||
### Source Material
|
||||
```
|
||||
|
||||
[CODE, APIs, SPECIFICATIONS, OR OTHER TECHNICAL CONTENT TO DOCUMENT]
|
||||
|
||||
```
|
||||
|
||||
**Special Requirements:**
|
||||
### Special Requirements
|
||||
- [Include examples / screenshots / diagrams]
|
||||
- [SEO considerations for web documentation]
|
||||
- [Translation requirements]
|
||||
@@ -50,26 +50,29 @@ Please structure the documentation with:
|
||||
5. Troubleshooting section
|
||||
6. Reference materials and links
|
||||
|
||||
**Additional Context:**
|
||||
### Additional Context
|
||||
[Any background information, existing documentation to reference, or specific pain points to address]
|
||||
```
|
||||
|
||||
## Example Input
|
||||
|
||||
```markdown
|
||||
**Documentation Type:** API Documentation
|
||||
### Documentation Type
|
||||
API Documentation
|
||||
|
||||
**Target Audience:** Frontend developers integrating with our REST API
|
||||
### Target Audience
|
||||
Frontend developers integrating with our REST API
|
||||
|
||||
**Technical Subject:** User authentication and profile management API
|
||||
### Technical Subject
|
||||
User authentication and profile management API
|
||||
|
||||
**Requirements:**
|
||||
### Requirements
|
||||
- **Scope**: Authentication endpoints, profile CRUD operations, error handling
|
||||
- **Format**: Markdown for developer portal
|
||||
- **Length**: Comprehensive reference with examples
|
||||
- **Technical Level**: Intermediate developers familiar with REST APIs
|
||||
|
||||
**Source Material:**
|
||||
### Source Material
|
||||
```python
|
||||
# Authentication endpoints
|
||||
@app.route('/api/auth/login', methods=['POST'])
|
||||
@@ -99,7 +102,7 @@ def update_profile():
|
||||
return jsonify(updated_profile)
|
||||
```
|
||||
|
||||
**Special Requirements:**
|
||||
### Special Requirements
|
||||
|
||||
- Include curl examples for each endpoint
|
||||
- Show both success and error response formats
|
||||
|
||||
Reference in new issue
Block a user