search

Code-dot-mil / code.mil

An experiment in open source at the Department of Defense.
https://www.code.mil
MIT License
1.28k stars 122 forks source link

How to write documentation #244

Open jotasprout opened 5 years ago

jotasprout commented 5 years ago

Issue:

Approach

Created How to Write Documentation page (for issue #240 ) including section on using labels (for issue #180 ) . Still working on it but looking for feedback and direction.

jordangov commented 5 years ago

Thanks @jotasprout! I'll try to review this coming week (along with @jgarber623-gov hopefully). Just as an FYI, we deploy PR preview URLs, so you can see this at: https://deploy-preview-244--code-mil.netlify.com/

jordangov commented 11 months ago

@david-saeger Why did we close this PR? Seems like at least a start to resolve #240 and #180? I see I made a bunch of comments previously, but could we not use this PR as the base to solve these issues?

david-saeger commented 11 months ago

Im game to open it again. Didnt see any of your comments responded to and it had been a couple years so figured it the conversation was more than stale.

jordangov commented 11 months ago

Im game to open it again. Didnt see any of your comments responded to and it had been a couple years so figured it the conversation was more than stale.

Yeah, it's definitely stale. But still might be a good starting point. Someone else (you? me? Nick?) could certainly address the comments and wrap this one up.

jotasprout commented 11 months ago

Sorry I didn't respond to the comments -- but I just saw the email about the latest one. I'll review the feedback, work on it, and report back ... unless someone else is doing it. May I?

jordangov commented 11 months ago

Sorry I didn't respond to the comments -- but I just saw the email about the latest one. I'll review the feedback, work on it, and report back ... unless someone else is doing it. May I?

@jotasprout No worries... it was a long time ago. :)

FYI, I no longer run the site, but happy to review content. @david-saeger is the gatekeeper now!