Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WD: Code with the Carolinas project #2231

Merged
merged 3 commits into from
Sep 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/conf/atlantic/2024/writing-day.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,3 +217,30 @@ The Good Docs Project - Template adoption workshop (second session)
For Writing Day, we'll give a brief introduction to our project, followed by a workshop that will give you a chance to provide feedback on how we can help more people use templates in their daily documentation workflows.

Get an early preview of `The Good Docs Project writing day agenda <https://tinyurl.com/good-docs-atlantic-2024>`__.

Code with the Carolinas
^^^^^^^^^^^^^^^^^^^^^^^

Join `Code with the Carolinas <https://codewiththecarolinas.org/>`__ to update and enhance our `Codeberg Repository Documentation <https://codeberg.org/Code_with_the_Carolinas/pages , https://codeberg.org/Code_with_the_Carolinas/pages/src/branch/main/CONTRIBUTING.md>`__. Codeberg is a free, open-source (FOSS) alternative to GitHub. Our goal is to develop inclusive documentation that is easier to understand and navigate.

Code with the Carolinas is a small, all-volunteer civic tech organization focused on using technology to benefit the community. We use Codeberg, an open source collaborative coding platform. The 'pages' repository maintained on Codeberg hosts the code for the website and a wiki with documentation. Our documentation and website have improved considerably since we brought this project to Writing Day for the first time in 2023.

Our goal for this year's Writing Day is to update the wiki and create more inclusive documentation for current and future contributors in the organization. We want clearer guidance for our contributors, regardless of their experience level.

To help align our project for Writing Day we have the following personas:

- Advanced contributors - regular contributors who use VSCode or similar text editors
- Beginner contributors - new or occasional contributeors who make small changes inline
- Core team contributors - core team members, founding team members, and Codeberg administrators

With your help, here's what we want to accomplish during Writing Day:

- Clearer onboarding documentation aimed at the new contributor persona
- Navigation improvements for the documentation wiki
- Create best practices for keeping documentation up to date
- Implement test cases for pull requests for content verification and compliance
- Review existing documentation to confirm it meets the needs of our user personas
- Create technical guides for merging code collaboratively authored in Codeberg
- Fixing content in our documentation using issues from the repository

We believe Writing Day will help us explore opportunities to attract contributors and encourage them to continue to collaborate with us. Thank you for your assistance and happy coding!