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

Redesign the website #8

Open
GarkGarcia opened this issue Dec 26, 2020 · 5 comments
Open

Redesign the website #8

GarkGarcia opened this issue Dec 26, 2020 · 5 comments

Comments

@GarkGarcia
Copy link
Contributor

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
Copy link
Member

rocky commented Dec 26, 2020

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
Copy link
Contributor Author

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
Copy link
Contributor Author

@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
Copy link
Member

rocky commented Dec 26, 2020

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.

@GarkGarcia
Copy link
Contributor Author

GarkGarcia commented Dec 26, 2020

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.

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

No branches or pull requests

2 participants