* Names must be as short as possible and unique across the documentation. * Remove as much content and HTML markup as possible, particularly content not associated with any entry (e.g.
By reducing the number of entries, we make it easier to find other, more relevant entries. Your documentation should only include documents that most developers may want to read semi-regularly. This is important because icons are the only thing differentiating search results in the UI. * Your documentation must come with an official icon, in both 1x and 2x resolutions (16x16 and 32x32 pixels). In addition to the (#contributing-code-and-features), the following guidelines apply to pull requests that add a new documentation: Feel free to get in touch if you're not sure if a documentation meets those requirements.
DEVDOCS REVIEW SOFTWARE
**Important:** the documentation's license must permit alteration, redistribution and commercial use, and the documented software must be released under an open source license.
DEVDOCS REVIEW HOW TO
See the () to learn how to add new documentations. Describe all your changes in the commit message and/or pull request. When it makes sense, squash your commits into a single commit.ħ. Try to keep your pull request small and simple.Ħ. If you're modifying the Ruby code, include tests and ensure they pass.ĥ. This also tells other contributors that you're working on the feature.ģ. Otherwise you risk spending a lot of time working on something we may not want to merge. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Search for existing issues someone may already be working on a similar feature.Ģ. Please don't open issues to request new documentations. Provide a clear and detailed explanation of the feature and why it's important to add it. Make sure your feature fits DevDocs's (./README.md#vision).ģ.
Search for similar feature requests someone may have already requested it.Ģ. browser/OS environment, log output, stack trace, screenshots, etc.).ġ. Share as much information as possible (e.g. Try to isolate the problem and include steps to reproduce it.Ĥ. Search for existing issues it's possible someone has already encountered this bug.ģ.
DEVDOCS REVIEW UPDATE
Update to the most recent main release the bug may already be fixed.Ģ. Please review the following guidelines carefully and search for existing issues before opening a new one.Ģ. , GitBook, readthedocs.Want to contribute? Great.
DEVDOCS REVIEW MANUAL
LLVM Programmer’s Manual - LLVM 13 documentation.Looking around at other large open source projects, a common pattern seems to be to host a developer documentation site that organizes things more comprehensively. The codebase itself, which probably works the best currently but is not easily discoverable, searchable, or editable.Our GitHub wiki, which has no overarching organization, has many rotted links, and is not easily searchable ( describes them as “write-only”).Internal wikis and posts, which are not visible to open source audiences.Surveys of our developers suggest that lack of component specific and system-wide documentation impede productivity.Ĭurrently, our dev docs are splattered around: We are pretty disorganized with regard to our developer docs (where dev docs are defined as documents covering our workflow or internal technical information-user-facing docs are a separate matter).
0 kommentar(er)
