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

A new structure for the Welcome page #32

Closed
contraexemplo opened this issue Sep 9, 2019 · 2 comments
Closed

A new structure for the Welcome page #32

contraexemplo opened this issue Sep 9, 2019 · 2 comments

Comments

@contraexemplo
Copy link
Contributor

@contraexemplo contraexemplo commented Sep 9, 2019

Proposal

This is the current structure of the Welcome page:

Welcome
├── Introductory paragraphs
│   ├── Short description of Open Collective
│   ├── Short description of the goal of our documentation
│   ├── Short instructions to suggest changes to any page
│   └── Short instructions to contact us: email and Slack
├── Overall FAQ
└── How to contribute to these docs

I propose restructuring the page as follows:

Welcome
├── Introductory paragraphs
│   ├── Short description of Open Collective
│   ├── Short description of the goal of our documentation
│   ├── How to explore our documentation
│           ├── Map explaining every section
│           └── Instructions on using the search bar
│   ├── How to contribute to our documentation
│           └──  Points to Contributing > Documentation > Suggesting changes
│   └── Short instructions to contact us: email and Slack
└── Overall FAQ

Documentation map

It should be added after revamping all pages of the documentation. Proposed format:

Name of the section
└── Brief description + link

Contribution guidelines

A draft of the Suggesting changes page is available on my own GitBook. It still needs:

  • Higher quality screenshots to add complementary information to every instruction
  • Instructions to add new files (media) or pages and sections to the repository
@alanna

This comment has been minimized.

Copy link
Contributor

@alanna alanna commented Sep 18, 2019

This looks good! Seems like a good approach. We want people to be able to quickly find what they are looking for and get an overview.

@contraexemplo contraexemplo unpinned this issue Oct 2, 2019
@contraexemplo

This comment has been minimized.

Copy link
Contributor Author

@contraexemplo contraexemplo commented Nov 26, 2019

Closed by 57a2744.

@contraexemplo contraexemplo moved this from In progress to Done in Google Season of Docs 2019 Nov 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2 participants
You can’t perform that action at this time.