Skip to content

A new structure for the Welcome page #32

Closed
@contraexemplo

Description

@contraexemplo

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

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions