stoplightio / dev-portal Goto Github PK

Describe the bug

Images are not loading

Summary

Make sure the documentation has good SEO across different projects

Tasks

• All pages should have titles and descriptions
• Ensure good load speed

User story.

As a user I should be able to provide feedback on every piece of documentation

Describe the solution you'd like

Embed a feedback widget on all documentation pages

Describe the bug

User story.

As a user I should be able to reach out to Stoplight on intercom

Describe the solution you'd like

Add intercom across the dev portal

User story.

As a use I should be able to easily copy the code samples in articles

User story.

As a user I should be able to find all important sections with clear descriptions on the landing page.

Describe the solution you'd like

Figma Prototype

https://www.figma.com/proto/CtiZLQnhCkiqOfL5JF2CwD/Untitled?node-id=1%3A2&scaling=min-zoom

Describe the bug

As a user its hard to make out when projects are being loaded as the loading icon appears at a weird place

To Reproduce

User story.

As a user I should be able to navigate the documentation easily on different screen sizes

User story.

As a user I should be able to view al documentation resources in one place

Questions

• what to do with zendesk / enterprise
• what to do with help.stoplight.io
• what to do with meta.stoplight.io
  • do we need redirects? will that even work?
• what to do with community.stoplight.io. do we want a forum in dev portal

Describe the bug

The spacing after an H1 makes it hard to read lists

Describe the bug

Dark mode makes the documentation unreadable

To Reproduce

User story.

As a user I should be able to search across the documentation.

Describe the solution you'd like

Allow users to search for docs/tutorials from the landing and documentation pages. This would require us to search across multiple elements projects.

User story.

As a user I should be able to view videos inside documentation

Is your feature request related to a problem?

Support embedding loom videos inside Stoplight docs

Describe the bug

As a user its hard to navigate the documentation on long articles

To Reproduce

User story.

As a user I should be able to see what's coming up in Stoplight.

Describe the solution you'd like

Embed product board portal in Stoplight

Hello, The three large icons on the dev landing page when clicked goes to 404 page. They are 'get started' 'setup an api program' and 'design an api'

Context

Was excited to learn about each of those aspects but instead landing on a page with 404, however, a determined user will not be stopped about learning more how to use Stoplight

Current Behavior

Icons when clicked landing 404 page

Expected Behavior

Landing pages that address those important areas with tutorials, videos that can get the user started using Stoplight

Possible Workaround/Solution

Luckily there are other links to pages to help us learn and do more.

Update the links for the icons

Steps to Reproduce

1. On Github's https://github.com/stoplightio/dev-portal
2. In the About section there is a link stoplight-dev-portal.vercel.app
3. when that link is clicked it goes to a landing page dubbed 'dev portal'
4. Clicking on those nice bright icons lead to 404 pages

Environment

• Version used: main branch
• Environment name and version (e.g. Chrome 39, node.js 5.4): chrome 111.0.5563
• Operating System and version (desktop or mobile): Windows 10
• Link to your environment/workspace/project: https://dreamsapi.stoplight.io/

User story.

Links being highlighted are weird especially with images

Summary

Create a readme for people to use and contribute to this template

Describe the bug

Stoplight flavoured markdown tabs are not working in elements

To Reproduce

Workspace:

Elements:

User story.

As a user I should be able to view what's new in Stoplight

Is your feature request related to a problem?

Add release notes project to dev portal

User story.

As documentation maintainers we should be able to measure their effectiveness

Describe the solution you'd like

Add amplitude to the documentation. TBD