Documentation good first issues

56 open issues currently match Documentation with the default 10+ star filter. This is the homepage feed limited to repositories tagged Documentation.

All issues · Browse projects · How to find good first issues

Showing 29 of ~56 matching filters (10+ stars · Documentation)

List

Broken Supermarq examples link

AI summary

The "Supermarq tutorial" link in the Supermarq README is broken, leading to a 404 error. The issue requires updating the link to point to the correct location of the tutorial documentation, which is currently unknown.

bugdocumentationgood first issue
100Documentation · API Documentation
Difficulty
1/5

Add strings next to the exclusion rules in pyproject.toml

AI summary

This issue requests adding descriptive strings next to exclusion rules within the `lint.ignore` section of the `pyproject.toml` file. The goal is to improve clarity by mirroring the existing practice for `lint.select` rules, making the configuration more understandable.

good first issuearea/checksintern-project
100Documentation · API Documentation
Difficulty
1/5

Add contributor instructions for updating environments.

AI summary

This issue requests adding a specific `conda` command to the contributor guide to instruct users on how to update their local development environment. The command `conda env update --name mkdocs --file build_env.yml --prune` should be added to the "Local Machine Setup" section of the documentation.

dev: enhancement 🛠️✨fix: inaccuracygood first issue
23Documentation · Website Documentation
Difficulty
1/5
yurt-page/docs

Domainless SMTP and alternative port 2525

AI summary

Implement a domainless SMTP server for the YurtPage project that defaults to port 2525 if port 25 is blocked, potentially using a single port for all mail-related protocols (SMTP, POP, etc.) to simplify configuration and bypass ISP firewalls.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5
yurt-page/docs

Update luci-app-email: new options and web mail

AI summary

Update the Luci app Email for OpenWrt to support new options from the upgraded EmailRelay package. This involves simplifying email enabling (e.g., single-click port enabling) and adding a basic web UI for reading and sending emails within Luci, accessible via a separate ACL for enhanced security. The web UI should prioritize simplicity, focusing on core functionality for most users, while allowing advanced users to utilize external mail clients.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5
yurt-page/docs

Mail client options

AI summary

Improve the user experience of email clients (FairMail, Thunderbird, Evolution, and K9 Mail) by enhancing their ease of use for Jabber-ID configuration, enabling default S/MIME signing with self-signed certificates (potentially linking to Actualis for certificate generation), and addressing other usability issues. This aims to make the YurtPage's email functionality more user-friendly and privacy-focused.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5
yurt-page/docs

DeltaChat XMPP intergation and XMPP over mail

AI summary

Integrate XMPP as a second communication protocol into DeltaChat, and explore the feasibility of using XMPP over SMTP/POP with limitations for messaging. This involves leveraging existing XMPP capabilities while respecting SMTP/POP constraints, focusing on message formatting but excluding server-interactive features unless server-side XMPP support is available.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5
yurt-page/docs

DeltaChat p2p

AI summary

Integrate DeltaChat's peer-to-peer messaging capabilities into the YurtPage self-hosting service. This involves enabling DeltaChat's SMTP server for direct email handling and utilizing MDNS/ZeroConf/Bonjour for service discovery within the local network.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5
yurt-page/docs

ER for DeltaChat

AI summary

Investigate the feasibility of integrating the existing Email Router (ER) system with DeltaChat's Python-based mail server. The goal is to determine if the ER can replace or enhance DeltaChat's current server functionality within the YurtPage self-hosting project, focusing on efficiency and compatibility.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5
yurt-page/docs

EmailRelay MDNS

AI summary

Implement Multicast DNS (mDNS) support for the Email Relay (ER) component of the YurtPage project. This will allow devices on the local network to automatically discover and connect to the ER for sending emails without needing to manually configure its IP address.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
3/5
yurt-page/docs

EmailRelay: load all acme certs

AI summary

The task is to modify the EmailRelay component of the YurtPage self-hosting project. The goal is to automate TLS certificate loading, eliminating manual configuration. The EmailRelay should automatically load all available ACME certificates to simplify setup and improve user experience.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5
yurt-page/docs

Spam protection

AI summary

The task involves implementing spam protection for a self-hosted homepage service called YurtPage, running on resource-constrained devices like routers. This requires either porting the rspamd spam filter to OpenWrt or developing a lighter alternative, such as a resurrected and ported version of Hashcash/Postmark.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5
yurt-page/docs

EmailRelay in Debian

AI summary

The task involves making the EmailRelay component of the YurtPage project available as a Debian package, ensuring compatibility across Debian-based systems like Ubuntu, FreedomBox, and Raspbian. This requires packaging the software appropriately for Debian's package management system and addressing any dependencies or conflicts.

enhancementhelp wanted
19Documentation · Tutorials
Difficulty
4/5

Fix Link Checker

AI summary

Debug a GitHub Actions workflow that's incorrectly failing link checks in the CivicActions Guidebook repository. The workflow, `check-all.yml`, needs to be investigated and fixed to accurately identify broken links.

bughelp wanted
20Documentation · Policy & Guidelines
Difficulty
4/5

No "Settings -> Create App" in API Walkthrough for dashboard v3.21.5 core v3.21.10

AI summary

Update the Saleor documentation's API Walkthrough section to reflect the change in the dashboard UI for adding webhooks in version 3.21.5 and later. The current instructions mention a "Settings -> Create App" path that no longer exists; the updated documentation should accurately reflect the current process, potentially using GraphQL as an example.

good first issueapps
107Documentation · Website Documentation
Difficulty
3/5

Documentation suggestion: mention equations and alignment in the manual

AI summary

Update the fletcher package's manual to include a section explaining how the package interacts with equations and their alignment points, using the provided example as a starting point. The documentation should clarify how to use fletcher's features within mathematical expressions and leverage alignment points for precise diagram placement.

documentationgood first issue
687Documentation · Diagram Drawing Libraries
Difficulty
2/5

AuthPolicy Missing Link

AI summary

Add a link to the 'AuthPolicyCommonSpec' section in the top-level navigation of the AuthPolicy documentation page. This involves updating the `mkdocs.yml` file to include this section in the navigation structure, ensuring consistency with other sections.

bugdocumentationgood first issuesize/small
15Documentation · Website Documentation
Difficulty
2/5

RateLimitPolicy Table of Contents

AI summary

Add a table of contents to the RateLimitPolicy documentation page, mirroring the existing structure found on the AuthPolicy, TLSPolicy, and DNSPolicy pages for improved consistency and user experience. This involves identifying the relevant sections within the RateLimitPolicy documentation and creating appropriate links for the table of contents.

documentationenhancementgood first issuesize/small
15Documentation · Website Documentation
Difficulty
2/5

DNS Policy Reference Page Cleanup

AI summary

Debug and fix inconsistencies in the DNS Policy reference page of the Kuadrant documentation. This involves correcting broken internal links, standardizing the 'Type' column formatting, and fixing broken links within the example section. The documentation is built using MkDocs and Mike for multi-versioning, and the fixes will need to be committed and potentially deployed using the described processes.

documentationgood first issuesize/small
15Documentation · Website Documentation
Difficulty
3/5

DNS Load Balancing Page - Improperly Formatted Links

AI summary

Debug and fix broken hyperlinks on the DNS Load Balancing page of the Kuadrant documentation (https://docs.kuadrant.io/1.2.x/kuadrant-operator/doc/user-guides/dns/load-balanced-dns/). The issue appears to be related to improper link formatting within the Markdown source files. The fix will involve locating the affected links, correcting their formatting, and verifying the changes by rebuilding and reviewing the documentation.

bugdocumentationgood first issuesize/small
15Documentation · Website Documentation
Difficulty
3/5

Outdated DNS policy link

AI summary

Update the link in the Kuadrant documentation (https://docs.kuadrant.io/1.2.x/kuadrant-operator/doc/user-guides/dns/basic-dns-configuration/) to point to the current version of the DNS policy documentation (https://docs.kuadrant.io/1.2.x/kuadrant-operator/doc/reference/dnspolicy/). This involves editing the Markdown file for the relevant page and potentially testing the updated link.

documentationgood first issuesize/small
15Documentation · Website Documentation
Difficulty
2/5

Enable most `'PT'` and `'SIM'` `ruff` rules in lint check

AI summary

The task is to update the Superstaq project's linting configuration to enable most of the `'PT'` (flake8-pytest-style) and `'SIM'` (flake8-simplify) rules from the `ruff` linter, while excluding a specific set of rules (PT012, PT019, PT022, SIM102, SIM105, SIM108, SIM118). This involves modifying the `pyproject.toml` file to include or exclude the appropriate rules.

good first issuehygienearea/checksarea/feature-requestintern-project
100Documentation · API Documentation
Difficulty
2/5

Getting Started 404 Link

AI summary

The Kuadrant documentation has a broken link to the 'Getting Started' page. The task is to fix this broken link in the 'Prerequisites' section of the tutorials, updating it to point to the correct, versioned URL (likely `https://docs.kuadrant.io/1.2.x/getting-started/`). This might involve updating the Markdown files in the documentation repository and potentially adjusting the MkDocs configuration to ensure proper versioning.

bugdocumentationgood first issue
15Documentation · Website Documentation
Difficulty
2/5

Also browsing: Software Development , AI/ML , Uncategorized