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.

Sign up for GitHub

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

Jump to bottom

Use something other than dox to parse documentation #8925

Closed
vkarpov15 opened this issue May 3, 2020 · 3 comments
Closed

Use something other than dox to parse documentation #8925

vkarpov15 opened this issue May 3, 2020 · 3 comments
Labels
confirmed-bug We've confirmed this is a bug in Mongoose and will fix it. developer-experience This issue improves error messages, debugging, or reporting docs This issue is due to a mistake or omission in the mongoosejs.com documentation

Comments

@vkarpov15
Copy link
Collaborator

Re: #8857, dox is long out of date and has a few upstream security vulnerabilities. Shouldn't impact users since dox is a dev dependency, but it causes confusion and reflects badly on us.
@vkarpov15 vkarpov15 added this to the 6.0 milestone May 3, 2020
@vkarpov15 vkarpov15 mentioned this issue Nov 19, 2020
Closed
@vkarpov15 vkarpov15 modified the milestones: 6.0, Parking Lot Jan 13, 2021
@IslandRhythms IslandRhythms added confirmed-bug We've confirmed this is a bug in Mongoose and will fix it. developer-experience This issue improves error messages, debugging, or reporting docs This issue is due to a mistake or omission in the mongoosejs.com documentation labels Jan 28, 2021
@hasezoey hasezoey mentioned this issue Jun 30, 2022
Merged
@hasezoey
Copy link
Collaborator

hasezoey commented Sep 5, 2022

once tj/dox#196 lands, would this issue still be needed?

the only "active" alternative i see is to use "typedoc", but for that to properly function, some typescript errors would have to be resolved

@Twipped
Copy link

Twipped commented Sep 7, 2022

https://github.com/tj/dox/releases/tag/v1.0.0

hasezoey added a commit to hasezoey/mongoose that referenced this issue Sep 7, 2022
@hasezoey
docs: update doc to 1.0.0
ece0fc1 
re Automattic#8925
@vkarpov15
Copy link
Collaborator Author

I'll close this one for now, given #12024. Thanks @hasezoey !

@vkarpov15 vkarpov15 removed this from the Parking Lot milestone Sep 27, 2022
@hasezoey hasezoey mentioned this issue Apr 4, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
confirmed-bug We've confirmed this is a bug in Mongoose and will fix it. developer-experience This issue improves error messages, debugging, or reporting docs This issue is due to a mistake or omission in the mongoosejs.com documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Twipped @vkarpov15 @hasezoey @IslandRhythms