-
Notifications
You must be signed in to change notification settings - Fork 253
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
Improve errors page #1299
Comments
As far as I could trace it, the decision to use a Anyway, it's obvious nothing/little was ever done, but before we scrap Other than that, I agree with everything written above. |
Absolutely !
I remember the discussion and yes it was supposed to be linked somehow with the core repo so that they could update it more easily but it did not end up with a viable process. I agree with you @dichotommy it would be better to have it on a |
I like Mailchimp's error page. |
Can we make Errors a separate heading instead of having it under API references? |
1378: Move errors page from yaml to md file under `reference/api` r=guimachiavelli a=guimachiavelli As part of our ongoing site restructure, I am moving the errors list from `reference/features` to `reference/api`, turning the `yaml` file into markdown as discussed on #1299. Co-authored-by: gui machiavelli <hey@guimachiavelli.com> Co-authored-by: gui machiavelli <gui@meilisearch.com>
I would support this change 👍🏻 |
This issue was partially solved by #1378 — a PR which replaced
In addition, #1378 did not completely remove the file responsible for converting |
I think we can cover this part in API references if we decide to go with the failure tabs with each example |
Completed ✅ |
Our current errors page (
errors.yaml
) is lacking in a couple ways.Problems:
.yaml
file does not add any value.yaml
file makes it difficult to integrate w/ VuePress.md
links do not work.yaml
file for this one page is inconsistent with our other site practices, and makes site maintenance less clear for external contributors and new team membersSolutions:
This is not our highest priority, but it should be done within the next six months—ideally before or during the migration to Docusaurus (#932 ).
The text was updated successfully, but these errors were encountered: