Skip to content

Commit

Permalink
overview page and version support initial pass #66 #73
Browse files Browse the repository at this point in the history
  • Loading branch information
brettfiedler committed Nov 21, 2024
1 parent 9cf7809 commit 7ad435e
Show file tree
Hide file tree
Showing 8 changed files with 45 additions and 9 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,18 @@ Here are some steps for using Mkdocs in your local dev environment. NOTE: if you

To edit (and optionally deploy) to the documentation website from a local machine (same steps GitHub Actions does):

- Install Python (3.11 last supported at deploy)
- Install module requirements using `pip install`. Install using the requirements.txt file in this directory.
- Install Python (3.13 last supported at deploy)
- (install `pip` and `venv` if not already installed)
- Create a new virtual environment
- e.g., `python -m venv ss_env`
- From the `../community`, install module requirements using `pip install -r requirements.txt`.
- run `mkdocs serve` to locally host the directory and preview changes in real-time in your browser (command will provide a local server link to open).
- Commit and push changes to `docs` branch
- `git add .`
- `git commit -m "your commit message"`
- `git push origin docs`
- If deploying from your local machine: run `mkdocs gh-deploy` and it will automatically build and push to the `gh-pages` branch and kick off a workflow for GitHub Pages to run a deploy Action.

## Licensing
## License

The libraries contained within [SceneryStack](http://scenerystack.org/) are licensed through the MIT License and freely available for use/reuse by anyone, including the `scenerystack/community` repository.
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contribution Guide

We're genuinely excited to have you here. Your interest in contributing to SceneryStack is appreciated, and this guide is here to assist you every step of the way. If you're curious about the differences between SceneryStack and PhET Interactive Simulations, we've covered that too!
We're excited to have you here! Your interest in contributing to SceneryStack is appreciated, and this guide is here to assist you every step of the way. If you're curious about the differences between SceneryStack and PhET Interactive Simulations, we've covered that too!

## How Can I Contribute?

Expand Down
Binary file added docs/assets/centerandvariabilitykeyboard.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/energyskatepark.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 18 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ The development libraries within SceneryStack were originally created by [PhET I

---

![Interactive in action with SceneryStack](assets/cck-bulb.gif)
![Interactive in action with SceneryStack](assets/energyskatepark.gif)

_[Interactive simulation](https://phet.colorado.edu/en/simulations/circuit-construction-kit-ac) created by PhET using SceneryStack_
_[Interactive simulation](https://phet.colorado.edu/en/simulations/energy-skate-park) created by PhET using SceneryStack_

---

Expand Down Expand Up @@ -62,6 +62,14 @@ Learn how to use SceneryStack in your web project or leverage the entire stack f

Choose your development path and [get started](./guides/pathways.md).

---

![Interactive in action with SceneryStack](assets/centerandvariabilitykeyboard.gif)

_[Interactive simulation](https://phet.colorado.edu/en/simulations/center-and-variability) created by PhET using SceneryStack_

---

## Community and Contributing 🤝

Looking to chat with others using SceneryStack, contribute to the community, or just need to ask some questions?
Expand All @@ -78,9 +86,17 @@ Head over to [Frequently Asked Questions](./guides/faqs.md) for questions asked

_[Interactive Music Video](https://jessegreenberg.github.io/cathedral/) by @jessegreenberg using SceneryStack - Try it here in the browser!_

---

## License

The libraries contained within SceneryStack, including this website, are under the MIT License and freely available for use by anyone. Authors using SceneryStack may choose any license for their creations.

??? warning "Licensing for PhET Interactive Simulations"
The _simulation source code_ for PhET Interactive Simulations is typically GPLv3 licensed or similar. For everything involving PhET Interactive Simulations, including partnerships, [see their website](https://phet.colorado.edu/).

---

![Interactive in action with SceneryStack](assets/cck-bulb.gif)

_[Interactive simulation](https://phet.colorado.edu/en/simulations/circuit-construction-kit-dc) created by PhET using SceneryStack_
10 changes: 7 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ repo_name: community
repo_url: https://github.com/scenerystack/community
edit_uri: edit/main/docs

extra:
version:
provider: mike # for versioning plugin

extra_css:
- stylesheets/extra.css

Expand Down Expand Up @@ -138,9 +142,9 @@ nav:
- Scenery and phet-lib: guides/scenery.md
- B. Framework:
- guides/simulation/simulation-development.md
- 1. PhET Development Guide: info-sync/simulation-development-overview.md
- 2. Introductory Exercises: info-sync/scenerystack-exercises.md
- 3. Software Design Patterns: info-sync/phet-software-design-patterns.md
- Sim Development Guide: info-sync/simulation-development-overview.md
- Introductory Exercises: info-sync/scenerystack-exercises.md
- Software Design Patterns: info-sync/phet-software-design-patterns.md
- Resources from PhET:
- PhET Sim Tooling: info-sync/chipper-deploy.md
- PhET TypeScript Conventions: info-sync/typescript-conventions.md
Expand Down
7 changes: 7 additions & 0 deletions overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,11 @@
Join us for our next Community Meeting on December 11, 2024 at 15:00 UTC! Join our <a
href="https://scenerystack.org/join/" target="_blank">Slack/Matrix</a> or check out the <a
href="https://github.com/orgs/scenerystack/discussions" target="_blank">GitHub Discussions</a> for info on joining.
{% endblock %}

{% block outdated %}
You're not viewing the latest version.
<a href="{{ '../' ~ base_url }}">
<strong>Click here to go to latest.</strong>
</a>
{% endblock %}
6 changes: 6 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ csscompressor==0.9.5
ghp-import==2.1.0
htmlmin2==0.1.13
idna==3.10
importlib_metadata==8.5.0
importlib_resources==6.4.5
Jinja2==3.1.4
jsmin==3.0.1
Markdown==3.7
MarkupSafe==3.0.2
mergedeep==1.3.4
mike==2.1.3
mkdocs==1.6.1
mkdocs-get-deps==0.2.0
mkdocs-material==9.5.44
Expand All @@ -25,11 +28,14 @@ pathspec==0.12.1
platformdirs==4.3.6
Pygments==2.18.0
pymdown-extensions==10.12
pyparsing==3.2.0
python-dateutil==2.9.0.post0
PyYAML==6.0.2
pyyaml_env_tag==0.1
regex==2024.11.6
requests==2.32.3
six==1.16.0
urllib3==2.2.3
verspec==0.1.0
watchdog==6.0.0
zipp==3.21.0

0 comments on commit 7ad435e

Please sign in to comment.