Skip to content

Comprehensive Audit Needed #32

@xronosuf

Description

@xronosuf

We have done a lot of meetings and revamps on the structures and naming schemes for the files in this repo. I've updated the main README.md file for the repo - which should be displayed in github now. But that leaves a few things that someone other than me should review and verify before marking this issue as closed.
It is possible (even likely) that almost all of the below are already set, the idea here is to make sure someone actually goes through every file/folder and verifies everything is set rather than rely on memory/assumption.

  1. I know Wim had a good workflow outlined for how to add new test files and/or composite test xourses once this examples repo has moved from alpha to beta status - i.e. once we have decided that the existing content has been solidified and we have a good format/structure and everything is up to date for the current status of the Ximera package. This still needs to be added to the README.md file in the relevant section.
  2. The files/folders have been moved around many times. I've largely tried to update the readme/file paths up to date as we go, but almost surely some stuff has been missed. Someone should go through and make sure that all the information files (the non-.tex files) are updated with the current structure.
  3. Someone else should also go through the main README.md other than me to add or edit things as necessary to make sure there aren't typos or old content from previous iterations. Again I think I got all this, but stuff gets missed.
  4. Someone should go through and make sure all the files are indeed have names that reflect the intended naming scheme outlined in the README.md. I didn't actually rename the xourse.tex and base.tex files to be the more helpful naming scheme we have since adopted (I know Bart has done at least some - all? - of this, but someone should verify)

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions