Skip to content

Commit 17db183

Browse files
authored
Create README.md
1 parent 530d671 commit 17db183

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Duck Dev Docs
2+
3+
Welcome to the official documentation repository for Duck Dev, LLP. This repository houses the source files that generate our live documentation site.
4+
5+
## 📚 Live Documentation
6+
7+
You can view the official, published documentation here:
8+
**[View Documentation](https://docs.duckdev.com)**
9+
10+
## 💡 About Duck Dev
11+
12+
Duck Dev, LLP is a small, two-person team driven by a love for open source and dedicated to creating helpful tools and resources for the developer community.
13+
14+
You can learn more about us on our official website:
15+
**[About Duck Dev](https://duckdev.com/about)**
16+
17+
## 🤝 Contributing
18+
19+
We welcome and encourage contributions from the community to help us keep our documentation accurate and comprehensive.
20+
21+
### Editing Existing Pages
22+
23+
For quick edits or fixing typos on an existing article, the easiest way to contribute is by using the edit link at the bottom of the live documentation page. This link will take you directly to the original source file in this repository, where you can submit a change request.
24+
25+
### Adding New Pages or Major Changes
26+
27+
If you would like to add entirely new documentation pages, sections, or submit a substantial change to the structure:
28+
29+
1. **Fork** this repository.
30+
2. Create a new branch (`git checkout -b feature/your-feature-name`).
31+
3. Make your changes and commit them (`git commit -m 'feat: add new page on [topic]'`).
32+
4. Push to your branch (`git push origin feature/your-feature-name`).
33+
5. **Submit a Pull Request (PR)** to the `main` branch of this repository.
34+
35+
We appreciate your effort and will review all submissions!
36+
37+
## 📄 License
38+
39+
This documentation is licensed under the **GPL (General Public License)**. See the LICENSE file for more details.

0 commit comments

Comments
 (0)