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

Documentation Status #45

Open

LightFLP opened this issue Sep 18, 2023 · 0 comments

Labels

Collaborator

LightFLP commented Sep 18, 2023 •

edited by lunalixxi

Loading

This issue is used to follow the progress on the completion status of Tracy's documentation.

Completion Status: 45% (18/38)

User documentation

Guides and tutorials(0/6)

Getting started
Using the search
Using the minimap
Using the Flags dialog
Using the States dialog
Using Structure Matching and Wildcards

Developer documentation

Guidelines and practices (2/4)

Getting started
~~Debugging tips~~ - done
~~Developer responsibilities~~ - done
Use of libraries and packages

React components (4/8)

App
ContextMenu
FlagsDialog
~~LogView~~ done
~~Minimap~~ - done
StatesDialog
~~StructureDialog~~ - done
~~StructureTable~~ - done

Enums (2/3)

SelectedRowType
~~StructureLinkDistance~~ - done
~~StructureHeaderColumnType~~ - done

Hooks (0/4)

useStructureEntryManager
useStructureRegularExpressionManager
useStyleManager
useWildcardManager

Types (9/9)

~~CellContents~~ - done
~~ContextMenuItem~~ - done
~~Header~~ - done
~~LogViewState~~ - done
~~logEntryCharMaps~~ - done
~~StructureEntry~~ - done
~~StructureMatchId~~ - done
~~Wildcard~~ - done
~~WildcardSubstitution~~ - done

Tables (0/4)

Table
FlagsTable
TransitionTable
StateTable

Constants (1/?)

~~LOG_COLUMN_WIDTH_LOOKUP~~ - done
???

LightFLP added the documentation label

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