Skip to content

Update README and documentation #5

@victoria-lo

Description

@victoria-lo

We’d like to make this tool more community-agnostic and easily reusable by other tech groups (for example: open source meetups, developer community organisations, hackathon groups, etc). Right now it is branded and structured around ragTechDev, but with a few adjustments it could serve a wider audience.

Goals:

  • Allow other tech communities to add their own brand (names, logos, colours) without needing deep code changes.
  • Provide a clear onboarding path for new communities to fork/customise the project.
  • Make configuration of templates (templates for social posts, event banners, etc) more flexible so communities can adapt text/layout/logo easily.
  • Keep the core functionality (canvas export, platform sizes, etc) intact, but separate “branding assets” from core logic.

Sub-issues:

We’d like to make this tool more community-agnostic and easily reusable by other tech groups (for example: open source meetups, developer community organisations, hackathon groups, etc). Right now it is branded and structured around ragTechDev, but with a few adjustments it could serve a wider audience.

Goals:

  • Allow other tech communities to add their own brand (names, logos, colours) without needing deep code changes.
  • Provide a clear onboarding path for new communities to fork/customise the project.
  • Make configuration of templates (templates for social posts, event banners, etc) more flexible so communities can adapt text/layout/logo easily.
  • Keep the core functionality (canvas export, platform sizes, etc) intact, but separate “branding assets” from core logic.

Sub-issues:

#5 Update README and documentation

Goal: Document how to fork and customise the tool for other communities.

Description:
Update project README to include a clear guide for new communities on adding their own branding.

Acceptance criteria:

  • Add “How to customise for your community” section.
  • Include example config and folder layout.
  • Add troubleshooting and best practices for branding.
  • Include screenshots or example output if possible.

Dependencies: #1#4

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions