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.

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

Documentation for svg creation procedures #75

Open
9 tasks done
superjai opened this issue Dec 15, 2024 · 1 comment
Open
9 tasks done

Documentation for svg creation procedures #75

superjai opened this issue Dec 15, 2024 · 1 comment
Assignees

Comments

@superjai
Copy link
Contributor

superjai commented Dec 15, 2024

As you know @robbiecarroll, the documentation for Sanctuary Watch needs some serious work. So, let's get started with that on your first github issue. I would appreciate it if you could please update the documentation for svg creation, as well as the associated image files.

If you do a pull, in the directory structure, you will notice a new folder called docs. This is where we will put documentation associated with Sanctuary Watch, as well as associated files. You will notice a subfolder in docs called training_images that contains some illustrator files and associated svg files.

The current (but very dated) documentation for svg creation can be found here.

Please do the following:

  • Do a pull on Sanctuary Watch to make sure that you have the current code.
  • Create a branch locally on your machine called robbiebranch or something like that.
  • Within that branch, create a markdown file titled "SVG creation" - or something like that.
  • Copy and paste the contents of the dated svg documentation into the new file, editing the content to account for the new mobile view as well as the need to put a transparent outline around icons within which it is hard to get mouse lock-on. Make any other edits you see a need for.
  • Update the associated image files in the training_images folder to include the mobile folder and the transparent outline for some icons. The icons in the folder don't really require an outline or a separate mobile icon, so please update the icons so that they do require them. Additionally, I just created these scenes fast using AI tools in Illustrator, so if you feel yourself to be morally injured working on these scenes, feel free to create new scenes that you like better.
  • Update the documentation to make clear that any text within the svg must use web-safe fonts.
  • Create a zipped version of the updated training_images folder and put links to that into the markdown file (replacing the links to the now-dated zip file containing svgs).
  • Commit and push your changes to the repo.
  • Create a pull request so that I can review your updates.
@robbiecarroll
Copy link
Contributor

Everything is going great! I'm checking in with Jai for the first session to make sure its formatted correctly and I'm using the correct files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants