Add Schema CSV import/export docs for workflow taxonomy management#84
Add Schema CSV import/export docs for workflow taxonomy management#84rskew wants to merge 1 commit into
Conversation
Document the new Schema CSV workflow for managing taxonomy structure, including CSV format reference, import/export instructions, and the recommended two-step approach (Schema CSV + taxon group CSVs). Reorganize existing content into clear sections for each approach (Schema CSV, Taxon Group CSV, JSON). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for highlighter-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the documentation for workflow taxonomy management by introducing and detailing the use of Schema CSVs. It provides comprehensive guidance on defining taxonomy structure, importing and exporting schema definitions, and outlines a recommended two-step process combining Schema CSVs with Taxon Group CSVs. The existing content has been reorganized to offer clearer distinctions between different taxonomy management approaches. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly updates the documentation for workflow taxonomy management. It introduces and details three primary methods for managing taxonomies: Schema CSVs for defining structure, Taxon Group CSVs for managing constrained attribute values, and JSON for full taxonomy snapshots. The documentation provides comprehensive instructions for accessing, importing, and exporting taxonomies using these methods, along with best practices and troubleshooting tips. Feedback includes improving the clarity and consistency of the 'Buttons' column in the taxonomy management table and adding a more prominent note to clarify that Schema CSV imports are additive and do not support deletions.
| | Approach | Best for | Buttons | | ||
| |---|---|---| | ||
| | **Schema CSV** | Defining object classes and their attributes (structure) | Export Schema CSV, Import Schema CSV | | ||
| | **Taxon Group CSV** | Defining constrained attribute values (e.g., dropdown options) | Existing taxon group import/export | |
There was a problem hiding this comment.
To improve clarity and consistency, the 'Buttons' column in this table should list the specific button labels for each approach. The current text 'Existing taxon group import/export' is a description, which is inconsistent with the other rows that list button names. Using the actual button labels will make this summary table more helpful for users.
| | **Taxon Group CSV** | Defining constrained attribute values (e.g., dropdown options) | Existing taxon group import/export | | |
| | **Taxon Group CSV** | Defining constrained attribute values (e.g., dropdown options) | Import Taxonomy, Export Taxonomy | |
| - **Create** new object classes and attributes that don't already exist | ||
| - **Update** existing attributes if their settings have changed (e.g., changing `required` from `false` to `true`) | ||
| - **Preserve** existing data — the import does not remove object classes or attributes that are absent from the CSV | ||
| - **Set sort order** based on row position in the CSV |
There was a problem hiding this comment.
The point that imports don't remove data is crucial. A user might incorrectly assume that providing a CSV without an attribute would delete it. To prevent this misunderstanding, this behavior should be highlighted more prominently. Consider adding a formal note after this list to explicitly state that deletions are not supported via CSV import.
For example:
> **Note:** The Schema CSV import is an additive process. It will not remove object classes or attributes that are absent from the imported file. Deletions must be performed manually through the user interface.1 participant
Document the new Schema CSV workflow for managing taxonomy structure, including CSV format reference, import/export instructions, and the recommended two-step approach (Schema CSV + taxon group CSVs). Reorganize existing content into clear sections for each approach (Schema CSV, Taxon Group CSV, JSON).
Requires updating when https://github.com/silverpond/highlighter/pull/1350 is merged, and this PR should not be merged until 1350 is released.