mathics / mathics.github.io

Mathics home page
https://mathics.org
6 stars 4 forks source link

Redesign the website #8

Open GarkGarcia opened 3 years ago

GarkGarcia commented 3 years ago

This website looks ugly as fuck. I'm thinking about using a template from https://html5up.net/. It's licensed under Creative Commons Attributions, so we should be able to use it.

@rocky Thoughts?

rocky commented 3 years ago

Sure if that is what you'd like to do - go for it!

I am more concerned that the content is a bit lacking.

GarkGarcia commented 3 years ago

Sure if that is what you'd like to do - go for it!

I am more concerned that the content is a bit lacking.

Indeed, I'll try to work on this too.

GarkGarcia commented 3 years ago

@rocky What kind of information would you like to include in the website? I've written small snippets of text on our main features (the fact that it's open-source, python integration and our multiple clients) and I plan on copying some of the installation instruction to the website.

rocky commented 3 years ago

The two things that I most feel pain over are:

GarkGarcia commented 3 years ago

The two things that I most feel pain over are:

  • an overview of how the code works. I am writing a first draft of this up now.

  • A simple tutorial that show how to starts of with the Hello[] buit-in and gets progressively more complex.

    • Add a simple parameter so Hello[rocky] works.
    • Document the command so that ?Hello works
    • Check that the parameter is a string - both in by pattern matching and by checking in the Python code
    • Make the parameter be optional - introduce how rules work.
    • Introduce other Attributes like Locked and Protected
    • Add a test in the markup docstring language
    • Show how to run just that test using test.py -s
    • Show how to run that test using py.test
    • Go over a more complicated example that involves different kinds of parameters as are found in Array[ ]
    • How to write a PyMathics Python module.

Alright. I've commited my changes to the side-redesign branch. You guys should be able to pull it and test it locally (just open index.html in your browser). I'll wait for your draft before merging this. On regards to your second point, I think it's better to deal with this in a separate PR.