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

General clean-up, especially around docs, in preparation for v1.0 #386

Merged
merged 8 commits into from
Nov 14, 2024

Conversation

ceriottm
Copy link
Contributor

@ceriottm ceriottm commented Nov 3, 2024

Mildly customized furo theme looks much better IMO

@ceriottm
Copy link
Contributor Author

ceriottm commented Nov 6, 2024

Fixed a couple of papercut bugs, and revamped the docs appearance. @Luthaf - IDK what you had in mind in terms of docs restructuring, overall it doesn't look bad to me as it is now.

@ceriottm
Copy link
Contributor Author

OK I tried also to look into the symbol bugs that @bernstei pointed at, but it looks like it's not a trivial fix so probably deserving of a separate PR. Time to merge this before it becomes an everything-pr!

@sofiia-chorna
Copy link
Collaborator

Thanks a lot for the clean up and update of the doc style! :)

I pushed a commit to fix a warning ignored unknown settings '{"size":{"reverse":true}}' that started to appear in some examples, like Dielectric Response.

@ceriottm
Copy link
Contributor Author

Thanks a lot for the clean up and update of the doc style! :)

I pushed a commit to fix a warning ignored unknown settings '{"size":{"reverse":true}}' that started to appear in some examples, like Dielectric Response.

Thanks - we actually removed this setting in a previous PR as it was pretty useless and complicating a lot the logic around size scaling. This error should actually be also already fixed as I modified the example .json - if you still get the error locally you probably need to clear your examples cache so they get downloaded again.

Comment on lines +401 to +406
// loads a random example
var exampleKeys = Object.keys(examples);
var randomIndex = Math.floor(Math.random() * exampleKeys.length);
var randomExampleKey = exampleKeys[randomIndex];

await app.loadExample(randomExampleKey);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm worried this might make loading the website slower, since some of the examples add a fairly large download. Zeolites.json.gz is 1.8MiB, and CSD-1000R.json.gz is 3.5 MiB

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, but chemiscope.min.js is 3MB already so even in the worst case it will make loading 2x slower....
Maybe we can test a bit and see if it's a problem, and in case I think the "right thing" would be to reduce a bit the size of the demo datasets.

ceriottm and others added 8 commits November 14, 2024 13:29
Tweaked icon, switch to furo, custom colors
When shapes got selected, it was not possible to go back to a
visualization without shapes by just crtl-clicking all entries
in the shape list. Had do move around some stuff making the code
a bit less transparent.
@Luthaf Luthaf merged commit f493599 into main Nov 14, 2024
6 checks passed
@Luthaf Luthaf deleted the tweak-docs branch November 14, 2024 12:42
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

Successfully merging this pull request may close these issues.

3 participants