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.

Sign up for GitHub

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

Jump to bottom

Consolidate shared documentation #11

Open
obscurerichard opened this issue Jan 3, 2025 · 0 comments
Open

Consolidate shared documentation #11

obscurerichard opened this issue Jan 3, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@obscurerichard
Copy link
Member

obscurerichard commented Jan 3, 2025 •
edited
Loading

We should put more of our shared documentation here, maybe pulling some of the maintenance information out of freezing-web, freezing-model, freezing-compose, and freezing-sync.

Good candidates include:

  • development environment instructions that are scattered between repos
  • database setup and aliases, currently in freezing-compose and freezing-web - but this is tricky as you still want to make it easy for people using freezing-web to get started.
  • architecture documentation scattered in README files, old mailing list posts, and some Slack posts
@obscurerichard obscurerichard mentioned this issue Jan 3, 2025
Open
@obscurerichard obscurerichard added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jan 3, 2025
@obscurerichard obscurerichard moved this from To do to Icebox in Freezing Saddles Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
Freezing Saddles
Status: Icebox
Milestone
No milestone
Development

No branches or pull requests
1 participant
@obscurerichard