Skip to content

Check: is the documentation up-to-date with the application? #1

Description

@gogo25171

Hello —

The documentation in this repository appears not to have been updated for some time (roughly ~2 years based on repository metadata). I reviewed the following files and found several indicators the content may be out of date:

Files reviewed

  • Documentation.docc/1.UI.md
  • Documentation.docc/2.Models.md
  • Documentation.docc/3.LoRa.md
  • Documentation.docc/4.ControlNET.md
  • Documentation.docc/5.TextInversion.md
  • Documentation.docc/6.Others.md
  • README.md

Key observations

  • Several pages include phrases such as “the app is under active development so expect some things can change”, “soon there will be way to delete models”, and “Importing SDXL controlNET is not supported right now”. These suggest the docs describe a previous app version and may be outdated.
  • The content appears community-written (frequent author: F_R_O_S_T_Y) and includes screenshots and UI-specific instructions; such details can become stale quickly after UI/feature updates.

Requested actions / questions

  1. Can you confirm whether this documentation is still actively maintained and synchronized with the current Draw Things application?
  2. If it is not actively maintained, could you point to the authoritative release notes or changelog (App Store release notes, internal changelog, or source repo) so contributors and users know where to check for accurate info?
  3. If the docs are maintained, please provide the date of the last update and the person or team responsible for documentation updates.

Suggested best practices (if the docs are not actively maintained)

  • Archive the repository on GitHub to make it explicit the content is no longer maintained, or add a clear deprecation notice at the top of the README pointing to the authoritative source.
  • Add a visible "Last updated" date at the top of major documentation pages to help readers judge freshness.
  • Maintain a short CHANGELOG or link to the app's official release notes (App Store / releases) from the README.
  • Add a CODEOWNERS or a 'Docs maintainer' contact in the README so contributors know who to tag for updates.
  • Provide an ISSUE / PR template for documentation updates and a simple CONTRIBUTING.md describing how to propose doc fixes.
  • Close or triage stale issues and label docs as "archived" or "deprecated" if applicable.

Goal: If you prefer, I can open a PR that lists sections that appear clearly outdated and propose updates based on the current app (I can include screenshots and a comparison).

Would you like me to attach example excerpts (file paths and short snippets) highlighting the potentially outdated sections to this issue?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

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