Skip to content

CNF Odoo Documentation

About This Documentation

This documentation site serves as the central repository for all CNF-specific Odoo customizations, processes, and procedures. It supplements the standard Odoo documentation with information specific to CNF's implementation.

How to Use This Site

Here you should be able to find any specific documentation relating to CNF's processes in Odoo. Since there have been many customizations made, the base Odoo documentation may be inadequate. If you are looking for base Odoo documentation you can find it here. If you are looking for something specific you can use the search bar in the top right.

What is Odoo

Odoo is an open-source enterprise resource planning (ERP) software that CNF uses to manage various business operations including purchasing, inventory, warehouse management, and more.

Documentation Sections

For Users

For Technical Staff

Target Audiences

This documentation serves multiple audiences: - Users - End users of the Odoo system - Administrators - System administrators managing Odoo - Developers - Technical staff maintaining and extending the system - Trainers - Staff responsible for training new users

Getting Help

If you find errors or have suggestions for improving the documentation, please contact the documentation team or submit a pull request to the repository.

Documentation Guidelines

This guide provides best practices and conventions for creating and maintaining documentation in the CNF Odoo documentation project.

File Structure

Directory Organization

  • Documentation is organized by user type and functionality
  • Main sections include:
  • odoo-user/ - General user documentation
  • odoo-admin/ - Administrator documentation
  • developer/ - Technical documentation
  • training/ - Training materials
  • ventor-user/ - Ventor mobile app documentation
  • legacy-sys/ - Legacy system documentation

File Naming Conventions

  • Use lowercase with hyphens for file names: inventory-management.md
  • Keep file names descriptive but concise
  • For multi-word concepts, use hyphens: purchase-order-workflow.md

Images and Media

Image Storage

Images should be stored in an attachments/ or assets/ subdirectory relative to the markdown file that references them:

docs/
├── odoo-user/
│   ├── purchase.md
│   └── attachments/
│       ├── Module_icon.png
│       └── purchase_menu.png

Image Linking

Use relative paths to link images from markdown files:

![Module Icon](attachments/Module_icon.png)

For images with specific dimensions, use HTML style attributes: 

![Purchase Menu](attachments/purchase_menu.png){:style="height:150px; width:800px"}

Image Naming Conventions

  • Use descriptive names: purchase_order_view.png not img1.png
  • Use underscores for multi-word image names
  • Keep names consistent with the content they represent

Writing Style

Headers

  • Use # for main page title
  • Use ## for major sections
  • Use ### for subsections
  • Avoid going deeper than ####

Content Structure

  1. Start each page with a clear title and brief introduction
  2. Use numbered lists for sequential steps
  3. Use bullet points for non-sequential information
  4. Include prerequisites when applicable
  5. Add objectives for training materials

Code Blocks

Use fenced code blocks with language specification:

# Python code example
def create_purchase_order():
    pass
  • Use relative links for internal documentation: 
    [User Guide](/odoo-user)
  • Use absolute URLs for external resources: 
    [Odoo Official Docs](https://www.odoo.com/documentation/13.0/)

Best Practices

Clarity and Accessibility

  • Write for your target audience
  • Define technical terms when first used
  • Use clear, concise language
  • Include examples where helpful

Maintenance

  • Review and update documentation regularly
  • Remove outdated information
  • Test all links and image references
  • Version-specific information should be clearly marked

Screenshots

  • Capture screenshots at consistent resolutions
  • Highlight or annotate important areas
  • Update screenshots when UI changes
  • Use meaningful file names that describe the content

Consistency

  • Follow established patterns in existing documentation
  • Use consistent terminology throughout
  • Maintain consistent formatting and structure
  • Use the same style for similar types of content

MkDocs Configuration

Markdown Extensions

The project uses several markdown extensions: - footnotes - For adding footnotes - meta - For page metadata - attr_list - For adding attributes to elements - pymdownx.highlight - For syntax highlighting - pymdownx.superfences - For nested code blocks

Version Control

Commit Messages

  • Use clear, descriptive commit messages
  • Reference issue numbers when applicable
  • Follow conventional commit format when possible

Branch Naming

  • Use descriptive branch names
  • Include issue numbers: 123-update-purchase-docs
  • Use hyphens to separate words

Review Process

Before publishing: 1. Proofread for spelling and grammar 2. Verify all links work correctly 3. Ensure images display properly 4. Test navigation structure 5. Validate markdown syntax 6. Review for technical accuracy