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

Explore frontend hosting options for better content accessibility #87

Open
5 tasks
ichoosetoaccept opened this issue Jan 21, 2025 · 3 comments
Open
5 tasks

Comments

@ichoosetoaccept
Copy link
Owner

Overview

Exploring options to create a more user-friendly frontend interface for the repository content while maintaining GitHub as the backend for contributions.

Current Situation

  • Repository is currently a standard GitHub repo with Markdown files
  • Content is accessible but could be more user-friendly for non-technical users
  • GitHub handles contributions well but navigation could be improved

Potential Solutions to Explore

Next.js + Cloudflare Pages

  • Would provide a modern, fast frontend
  • Cloudflare Pages offers free hosting
  • Can automatically rebuild when GitHub content changes
  • Zero additional hosting costs
  • Uses GitHub as the backend source of truth

Key Requirements

  • Must maintain easy contribution flow through GitHub
  • Should auto-update when content changes
  • Minimal maintenance overhead
  • Cost-effective (preferably free) hosting
  • Better content discoverability and navigation

Next Steps

  • Research Cloudflare Pages integration with GitHub
  • Investigate Next.js static site generation for our use case
  • Look into deployment and maintenance requirements
  • Consider impact on contribution workflow
  • Estimate development effort required

Notes

This would provide a more polished experience for content consumers while keeping the straightforward GitHub-based workflow for contributors. The dual approach (GitHub for contributions, frontend for consumption) could offer the best of both worlds.

@ichoosetoaccept
Copy link
Owner Author

Some additional alternatives to consider:

Documentation-Focused Solutions

MkDocs

  • Python-based static site generator designed for documentation
  • Material theme offers excellent UX and features
  • Built-in search functionality
  • Can use markdown files directly from repo
  • Easy navigation structure with yaml config
  • Can auto-deploy via GitHub Actions

GitBook

  • More polished, GUI-based solution
  • Excellent search and navigation
  • Can sync with GitHub repository
  • Provides nice editing interface for non-technical users
  • Built-in versioning and content organization

Docusaurus

  • React-based, by Facebook/Meta
  • Good balance between docs and landing page features
  • Strong MDX support for interactive content
  • Built-in versioning, search, and i18n
  • Can pull content directly from GitHub

Any of these could be valid alternatives to a custom Next.js solution. They'd require less development effort since they're purpose-built for documentation, but might be slightly less flexible for custom features. They all support keeping GitHub as the source of truth while providing a more user-friendly interface for content consumption.

@ichoosetoaccept ichoosetoaccept changed the title [DRAFT] Explore frontend hosting options for better content accessibility Explore frontend hosting options for better content accessibility Jan 21, 2025
@SchneiderSam
Copy link
Contributor

Nice one!

So if i Understand right: this issue replaces this one? #75

If so, here some inspiration:

And fi so @ichoosetoaccept feel free to close #75

@ichoosetoaccept
Copy link
Owner Author

Hey!

No it is not meant to replace a "prompt directory". #75 could end up being a section of this new docs site. What I mean with this issue is to have the content displayed in a more inviting form. Examples:

Instead of having the content live in a static README.md we could set up a full documentation site like in these examples and have the content be sourced from this Github repo.

It would make the content easier and nicer to look at, faster, easier to use etc. The added benefit here would be that people would be more likely to actually use this resource and, in turn, find it useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants