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

Reorganize docs and add in FAQ. #2234

Merged
merged 2 commits into from Nov 16, 2020
Merged

Conversation

ckipp01
Copy link
Member

@ckipp01 ckipp01 commented Nov 16, 2020

This breaks up the side bar a bit. Up to this point we just had the three following sections:

  • Text Editors
  • Build Tools
  • Contributing

Screenshot 2020-11-16 at 13 40 34

A whole bunch of stuff has found its way into Contributing that probably doesn't belong there, so I've tried to shift things around a bit. Now you'll see the following:

  • Text Editors
  • Build Tools
  • Contributing
  • LSP Extensions/DAP
  • Integrating with Metals
  • Troubleshooting

Screenshot 2020-11-16 at 13 41 10

I also added in a new faq page that I included some of the common questions that I've been seeing lately. There are definitely more, so feel free to add some as well if there are any that pop into mind or as you come across them.

Let me know what you think of the new structure, if you'd rather things shifted around, etc.

@ckipp01 ckipp01 added the documentation Tickets related to website and other documentation label Nov 16, 2020
Copy link
Contributor

@tgodzik tgodzik left a comment

Choose a reason for hiding this comment

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

Great work @ckipp01 ! Thanks for improving the docs. I just have a couple of questions. (Edit: or really comments)

docs/troubleshooting/faq.md Show resolved Hide resolved
docs/troubleshooting/faq.md Outdated Show resolved Hide resolved
website/i18n/en.json Show resolved Hide resolved
Copy link
Member

@olafurpg olafurpg left a comment

Choose a reason for hiding this comment

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

The new sidebar structure looks great! Thank you @ckipp01 🙏

@ckipp01
Copy link
Member Author

ckipp01 commented Nov 16, 2020

Great work @ckipp01 ! Thanks for improving the docs. I just have a couple of questions. (Edit: or really comments)

Sound good. Changed it around a bit per your suggestion.

Screenshot 2020-11-16 at 15 24 29

Copy link
Contributor

@tgodzik tgodzik left a comment

Choose a reason for hiding this comment

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

LGTM!

@ckipp01 ckipp01 merged commit 8f1c5db into scalameta:main Nov 16, 2020
@ckipp01 ckipp01 deleted the docs-reorganize branch November 16, 2020 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Tickets related to website and other documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants