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

Minor documentation improvements #487

Merged
merged 5 commits into from
Apr 22, 2021

Conversation

ajstewart
Copy link
Contributor

@ajstewart ajstewart commented Apr 9, 2021

Includes the following improvements:

  • Epoch Based Beamwidth Limit Clarification Somehow I had missed adding clarification on the behaviour of the initial on-sky separation limit during de Ruiter association when epoch based association is used. I felt sure I had but I couldn't find it!
  • Dark Mode Enabled a dark mode for the docs.
  • .env File information Added some details about the settings in the .env file as I thought this was lacking.
  • Clarified Django Q Just to make a bit clearer that it is needed for running jobs via the website.
  • VAST Icon Created VAST logo in an icon resolution so it doesn't appear stretched.

@ajstewart ajstewart added the documentation Improvements or additions to documentation label Apr 9, 2021
@ajstewart ajstewart requested a review from marxide April 9, 2021 11:20
@ajstewart ajstewart self-assigned this Apr 9, 2021
@github-actions github-actions bot added this to In progress in Pipeline Backlog Apr 9, 2021
- Added dark mode to docs.
- Added text about the .env file to documentation.
- Clarified and made clearer the Django Q requirement for running jobs.
@ajstewart ajstewart changed the title Add epoch based association clarification to documentation Minor documentation improvements Apr 15, 2021
marxide
marxide previously approved these changes Apr 19, 2021
docs/quickstart/configuration.md Outdated Show resolved Hide resolved
docs/quickstart/configuration.md Outdated Show resolved Hide resolved
docs/quickstart/configuration.md Outdated Show resolved Hide resolved
docs/quickstart/configuration.md Outdated Show resolved Hide resolved
docs/quickstart/configuration.md Outdated Show resolved Hide resolved
docs/quickstart/configuration.md Outdated Show resolved Hide resolved
Pipeline Backlog automation moved this from In progress to Reviewer approved Apr 19, 2021
@marxide
Copy link
Contributor

marxide commented Apr 19, 2021

Looks good! I love the dark mode, but since it's unlabelled I only knew it was there because you mentioned it to me earlier. I wonder if changing the icon to the weather-sunny and weather-night icons would be better than the current toggle switch? Just a thought, I don't feel very strongly about it.

Co-authored-by: Andrew O'Brien <marxide@users.noreply.github.com>
Pipeline Backlog automation moved this from Reviewer approved to Review in progress Apr 19, 2021
@ajstewart
Copy link
Contributor Author

Looks good! I love the dark mode, but since it's unlabelled I only knew it was there because you mentioned it to me earlier. I wonder if changing the icon to the weather-sunny and weather-night icons would be better than the current toggle switch? Just a thought, I don't feel very strongly about it.

This did cross my mind, I guess I have used so many dark modes now that I would be expecting that toggle to switch modes, there is also the hover info:

Screen Shot 2021-04-19 at 23 47 48

The toggle is the default, the bundled options are:

Screen Shot 2021-04-19 at 23 49 28

I do like the toggle as I like the minimalist approach, but I'd probably vote for the lightbulbs if we wanted more of a graphical representation? Though like you, I don't have that strong feelings on it.

@ajstewart
Copy link
Contributor Author

@marxide 7389173 bumps mkdocs-material to 7.1.1 minimum as I noticed dark mode wasn't working when I was on a lower version.

I had a look to see what the other icons looked like but I still vote for the toggle in the end, simple because in my opinion, the icon indicates that it's something that can be toggled where as the other images don't really indicate that it's something that can be clicked.

Pipeline Backlog automation moved this from Review in progress to Reviewer approved Apr 22, 2021
@ajstewart ajstewart changed the base branch from master to dev April 22, 2021 23:35
@ajstewart ajstewart merged commit 2ca8f0e into dev Apr 22, 2021
Pipeline Backlog automation moved this from Reviewer approved to Done Apr 22, 2021
@ajstewart ajstewart deleted the docs-epoch-mode-de-ruiter-clarification branch April 22, 2021 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants